diff --git a/CHANGES.md b/CHANGES.md index 24b6b375..a2011bb8 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,16 @@ twilio-oai changelog ==================== +[2024-01-25] Version 1.53.0 +--------------------------- +**Oauth** +- updated openid discovery endpoint uri **(breaking change)** +- Added device code authorization endpoint +- added oauth JWKS endpoint +- Get userinfo resource +- OpenID discovery resource +- Add new API for token endpoint + + [2024-01-14] Version 1.52.1 --------------------------- **Push** diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 2229f981..08dd60ad 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -15,13 +15,7 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The promoted Auth Token that must be used to authenticate future API requests.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 0 - } - } + "description": "The promoted Auth Token that must be used to authenticate future API requests." }, "date_created": { "type": "string", @@ -69,13 +63,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -119,13 +107,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -161,13 +143,7 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number in SafeList.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The phone number in SafeList." } } }, @@ -197,13 +173,7 @@ "secondary_auth_token": { "type": "string", "nullable": true, - "description": "The generated secondary Auth Token that can be used to authenticate future API requests.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 0 - } - } + "description": "The generated secondary Auth Token that can be used to authenticate future API requests." }, "url": { "type": "string", @@ -234,7 +204,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1009,12 +979,6 @@ "description": "The phone number to be fetched from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } } } ], @@ -1052,12 +1016,6 @@ "description": "The phone number to be removed from SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } } } ], diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 9ba5e89d..4768ec3a 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -7,13 +7,7 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The authorization token for this account. This token should be kept a secret, so no sharing.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The authorization token for this account. This token should be kept a secret, so no sharing." }, "date_created": { "type": "string", @@ -30,13 +24,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -113,13 +101,7 @@ "customer_name": { "type": "string", "nullable": true, - "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -136,13 +118,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "iso_country": { "type": "string", @@ -153,13 +129,7 @@ "postal_code": { "type": "string", "nullable": true, - "description": "The postal code of the address.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The postal code of the address." }, "region": { "type": "string", @@ -177,13 +147,7 @@ "street": { "type": "string", "nullable": true, - "description": "The number and street address of the address.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The number and street address of the address." }, "uri": { "type": "string", @@ -208,13 +172,7 @@ "street_secondary": { "type": "string", "nullable": true, - "description": "The additional number and street address of the address.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The additional number and street address of the address." } } }, @@ -428,6 +386,18 @@ "nullable": true, "description": "The SID that we assigned to the Connect App." }, + "date_created": { + "type": "string", + "format": "date-time-rfc-2822", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time-rfc-2822", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, "permissions": { "type": "array", "items": { @@ -1165,46 +1135,22 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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", @@ -1266,13 +1212,7 @@ "forwarded_from": { "type": "string", "nullable": true, - "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty." }, "group_sid": { "type": "string", @@ -1285,13 +1225,7 @@ "caller_name": { "type": "string", "nullable": true, - "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty." }, "queue_time": { "type": "string", @@ -1353,23 +1287,11 @@ "properties": { "request": { "nullable": true, - "description": "Contains a dictionary representing the request of the call.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "Contains a dictionary representing the request of the call." }, "response": { "nullable": true, - "description": "Contains a dictionary representing the call response, including a list of the call events.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "Contains a dictionary representing the call response, including a list of the call events." } } }, @@ -2123,24 +2045,12 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The company name set for the Connect App." }, "deauthorize_callback_method": { "type": "string", @@ -2160,47 +2070,23 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The description of the Connect App." }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "homepage_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The public URL where users can obtain more information about this Connect App.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The public URL where users can obtain more information about this Connect App." }, "permissions": { "type": "array", @@ -2256,13 +2142,7 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "phone_number": { "type": "string", @@ -2533,13 +2413,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "identity_sid": { "type": "string", @@ -2805,13 +2679,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "description": { "type": "string", @@ -2890,13 +2758,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "product_name": { "type": "string", @@ -2990,13 +2852,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "identity_sid": { "type": "string", @@ -3302,13 +3158,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "identity_sid": { "type": "string", @@ -3614,13 +3464,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "identity_sid": { "type": "string", @@ -3870,13 +3714,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -3991,13 +3829,7 @@ "body": { "type": "string", "nullable": true, - "description": "The text content of the message", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The text content of the message" }, "num_segments": { "type": "string", @@ -4014,24 +3846,12 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "description": "The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent." }, "to": { "type": "string", "nullable": true, - "description": "The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "description": "The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)" }, "date_updated": { "type": "string", @@ -4214,7 +4034,7 @@ "type": "string", "$ref": "#/components/schemas/message_feedback_enum_outcome", "nullable": true, - "description": "Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio)." + "description": "Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/sms/send-message-feedback-to-twilio)." }, "date_created": { "type": "string", @@ -4256,13 +4076,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -4297,13 +4111,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -4561,13 +4369,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "account_sid": { "type": "string", @@ -4581,13 +4383,7 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -5221,13 +5017,7 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The text content of the transcription." }, "type": { "type": "string", @@ -5406,13 +5196,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The string that you assigned to describe the resource." }, "sid": { "type": "string", @@ -5450,13 +5234,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The string that you assigned to describe the resource." }, "sid": { "type": "string", @@ -5498,13 +5276,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The string that you assigned to describe the resource." }, "sid": { "type": "string", @@ -5546,13 +5318,7 @@ "username": { "type": "string", "nullable": true, - "description": "The username for this credential.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The username for this credential." }, "date_created": { "type": "string", @@ -5747,13 +5513,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." }, "voice_method": { "type": "string", @@ -5787,25 +5547,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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 using the `voice_method` when the domain receives a call.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The URL we call using the `voice_method` when the domain receives a call." }, "subresource_uris": { "type": "object", @@ -6283,13 +6031,7 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The text content of the transcription." }, "type": { "type": "string", @@ -9427,13 +9169,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `callback_method` when the trigger fires.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 60 - } - } + "description": "The URL we call using the `callback_method` when the trigger fires." }, "current_value": { "type": "string", @@ -9874,25 +9610,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -9922,7 +9646,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -10148,12 +9872,6 @@ "description": "Only return the Account resources with friendly names that exactly match this name.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -10208,50 +9926,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -10694,12 +10396,6 @@ "description": "The `customer_name` of the Address resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -10708,12 +10404,6 @@ "description": "The string that identifies the Address resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -10768,50 +10458,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -11312,50 +10986,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -11817,50 +11475,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -12009,50 +11651,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -12424,50 +12050,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -12719,50 +12329,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -13014,50 +12608,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -13309,50 +12887,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -13604,50 +13166,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -13899,50 +13445,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -14194,50 +13724,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -14693,12 +14207,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } } }, { @@ -14708,12 +14216,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } } }, { @@ -14833,50 +14335,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -15300,50 +14786,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -15941,50 +15411,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -16224,50 +15678,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -16850,50 +16288,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -17259,50 +16681,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -17626,50 +17032,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -17778,50 +17168,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -18256,12 +17630,6 @@ "description": "A string that identifies the IncomingPhoneNumber resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -18324,50 +17692,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -18869,50 +18221,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -19206,50 +18542,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -19317,12 +18637,6 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -19385,50 +18699,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -19718,12 +19016,6 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -19786,50 +19078,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -20119,12 +19395,6 @@ "description": "A string that identifies the resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -20187,50 +19457,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -20734,50 +19988,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -21113,50 +20351,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -21441,50 +20663,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -21646,7 +20852,7 @@ }, "ShortenUrls": { "type": "boolean", - "description": "For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be provided." + "description": "For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/how-to-configure-link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be provided." }, "ScheduleType": { "type": "string", @@ -21669,12 +20875,12 @@ "RiskCheck": { "type": "string", "$ref": "#/components/schemas/message_enum_risk_check", - "description": "For SMS pumping protection feature only: Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request." + "description": "For SMS pumping protection feature only (public beta to be available soon): Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request." }, "From": { "type": "string", "format": "phone-number", - "description": "The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool." + "description": "The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool." }, "MessagingServiceSid": { "type": "string", @@ -21693,7 +20899,7 @@ "type": "string", "format": "uri" }, - "description": "The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply." + "description": "The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply." }, "ContentSid": { "type": "string", @@ -21749,12 +20955,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } } }, { @@ -21764,12 +20964,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } } }, { @@ -21842,50 +21036,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -22338,50 +21516,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -22585,50 +21747,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -22874,12 +22020,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -22888,12 +22028,6 @@ "description": "The string that identifies the OutgoingCallerId resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -22939,50 +22073,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -23728,10 +22846,6 @@ "Trim": { "type": "string", "description": "Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`." - }, - "CallToken": { - "type": "string", - "description": "A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call." } }, "required": [ @@ -23840,50 +22954,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -24455,50 +23553,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -24876,50 +23958,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -25190,50 +24256,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -25540,50 +24590,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -25834,50 +24868,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -26169,50 +25187,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -26621,50 +25623,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -26988,50 +25974,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -27369,50 +26339,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -27661,50 +26615,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -28107,50 +27045,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -28589,50 +27511,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -28891,50 +27797,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -29475,50 +28365,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -30096,50 +28970,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -30248,50 +29106,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -32897,50 +31739,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33087,50 +31913,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33264,50 +32074,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33441,50 +32235,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33618,50 +32396,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33795,50 +32557,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -33972,50 +32718,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -34149,50 +32879,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -34326,50 +33040,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -34503,50 +33201,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -34974,50 +33656,34 @@ } }, "end": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" + "type": "integer" }, "first_page_uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" + "format": "uri" }, "next_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" + "nullable": true }, "page": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" + "type": "integer" }, "page_size": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" + "type": "integer" }, "previous_page_uri": { "type": "string", "format": "uri", - "nullable": true, - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" + "nullable": true }, "start": { - "type": "integer", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" + "type": "integer" }, "uri": { "type": "string", - "format": "uri", - "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", - "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" + "format": "uri" } } } @@ -35305,71 +33971,6 @@ "GA" ] } - }, - "/healthcheck": { - "x-twilio": { - "className": "health_check", - "libraryVisibility": "private", - "docs_visibility": "private", - "pathType": "instance", - "x-skip-path": "true" - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "get": { - "operationId": "FetchHealthCheck", - "description": "API HealthCheck", - "security": [], - "tags": [ - "Api20100401HealthCheck" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Healthcheck\")", - "type": "object", - "properties": { - "status": { - "description": "HealthCheck status", - "type": "string" - } - } - } - } - } - } - }, - "x-twilio": { - "pathType": "instance", - "fixedResponse": { - "statusCode": 200, - "content": { - "status": "ok" - } - }, - "transactions": [ - { - "name": "validateHealthCheck", - "request": { - "method": "GET", - "url": "https://api.twilio.com/healthcheck.json" - }, - "response": { - "statusCode": 200, - "content": { - "status": "ok" - } - } - } - ] - } - } } }, "servers": [ @@ -35453,9 +34054,6 @@ { "name": "Api20100401FeedbackSummary" }, - { - "name": "Api20100401HealthCheck" - }, { "name": "Api20100401IncomingPhoneNumber" }, diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json new file mode 100644 index 00000000..5ca53c04 --- /dev/null +++ b/spec/json/twilio_autopilot_v1.json @@ -0,0 +1,5039 @@ +{ + "components": { + "schemas": { + "autopilot.v1.assistant": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Assistant resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." + }, + "latest_model_build_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Reserved." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of the URLs of the Assistant's related resources." + }, + "log_queries": { + "type": "boolean", + "nullable": true, + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." + }, + "development_stage": { + "type": "string", + "nullable": true, + "description": "A string describing the state of the assistant." + }, + "needs_model_build": { + "type": "boolean", + "nullable": true, + "description": "Whether model needs to be rebuilt." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Assistant resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. It can be up to 64 characters long." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Assistant resource." + }, + "callback_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "Reserved." + }, + "callback_events": { + "type": "string", + "nullable": true, + "description": "Reserved." + } + } + }, + "autopilot.v1.assistant.defaults": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Defaults resource." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Defaults resource." + }, + "data": { + "nullable": true, + "description": "The JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." + } + } + }, + "autopilot.v1.assistant.dialogue": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Dialogue resource." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Dialogue resource." + }, + "data": { + "nullable": true, + "description": "The JSON string that describes the dialogue session object." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Dialogue resource." + } + } + }, + "autopilot.v1.assistant.task.field": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Field resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "field_type": { + "type": "string", + "nullable": true, + "description": "The Field Type of the field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the unique_name, or the SID of a custom Field Type." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with this Field." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UE[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Field resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Field resource." + } + } + }, + "autopilot.v1.assistant.field_type": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the FieldType resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of the URLs of related resources." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the FieldType resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the FieldType resource." + } + } + }, + "autopilot.v1.assistant.field_type.field_value": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the FieldValue resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "field_type_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Field Type associated with the Field Value." + }, + "language": { + "type": "string", + "nullable": true, + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`" + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the FieldValue resource." + }, + "value": { + "type": "string", + "nullable": true, + "description": "The Field Value data." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the FieldValue resource." + }, + "synonym_of": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The word for which the field value is a synonym of." + } + } + }, + "autopilot.v1.assistant.model_build": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ModelBuild resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the ModelBuild resource." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/model_build_enum_status", + "nullable": true, + "description": "The status of the model build process. Can be: `enqueued`, `building`, `completed`, or `failed`" + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the ModelBuild resource." + }, + "build_duration": { + "type": "integer", + "nullable": true, + "description": "The time in seconds it took to build the model." + }, + "error_code": { + "type": "integer", + "nullable": true, + "description": "If the `status` for the model build is `failed`, this value is a code to more information about the failure. This value will be null for all other statuses. See [error code dictionary](https://www.twilio.com/docs/api/errors) for a description of the error." + } + } + }, + "model_build_enum_status": { + "type": "string", + "enum": [ + "enqueued", + "building", + "completed", + "failed", + "canceled" + ] + }, + "autopilot.v1.assistant.query": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Query resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "results": { + "nullable": true, + "description": "The natural language analysis results that include the [Task](https://www.twilio.com/docs/autopilot/api/task) recognized and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field)." + }, + "language": { + "type": "string", + "nullable": true, + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query. For example: `en-US`." + }, + "model_build_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) queried." + }, + "query": { + "type": "string", + "nullable": true, + "description": "The end-user's natural language input." + }, + "sample_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Query resource." + }, + "status": { + "type": "string", + "nullable": true, + "description": "The status of the Query. Can be: `pending-review`, `reviewed`, or `discarded`" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Query resource." + }, + "source_channel": { + "type": "string", + "nullable": true, + "description": "The communication channel from where the end-user input came." + }, + "dialogue_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue)." + } + } + }, + "autopilot.v1.restore_assistant": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Assistant resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Assistant resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." + }, + "needs_model_build": { + "type": "boolean", + "nullable": true, + "description": "Whether model needs to be rebuilt." + }, + "latest_model_build_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Reserved." + }, + "log_queries": { + "type": "boolean", + "nullable": true, + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." + }, + "development_stage": { + "type": "string", + "nullable": true, + "description": "A string describing the state of the assistant." + }, + "callback_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "Reserved." + }, + "callback_events": { + "type": "string", + "nullable": true, + "description": "Reserved." + } + } + }, + "autopilot.v1.assistant.task.sample": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sample resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the resource." + }, + "language": { + "type": "string", + "nullable": true, + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Sample resource." + }, + "tagged_text": { + "type": "string", + "nullable": true, + "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Sample resource." + }, + "source_channel": { + "type": "string", + "nullable": true, + "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." + } + } + }, + "autopilot.v1.assistant.style_sheet": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StyleSheet resource." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the StyleSheet resource." + }, + "data": { + "nullable": true, + "description": "The JSON string that describes the style sheet object." + } + } + }, + "autopilot.v1.assistant.task": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of the URLs of related resources." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Task resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + }, + "actions_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL from which the Assistant can fetch actions." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Task resource." + } + } + }, + "autopilot.v1.assistant.task.task_actions": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskActions resource." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the TaskActions resource." + }, + "data": { + "nullable": true, + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." + } + } + }, + "autopilot.v1.assistant.task.task_statistics": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskStatistics resource." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the statistics were collected." + }, + "samples_count": { + "type": "integer", + "nullable": true, + "description": "The total number of [Samples](https://www.twilio.com/docs/autopilot/api/task-sample) associated with the Task." + }, + "fields_count": { + "type": "integer", + "nullable": true, + "description": "The total number of [Fields](https://www.twilio.com/docs/autopilot/api/task-field) associated with the Task." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the TaskStatistics resource." + } + } + }, + "autopilot.v1.assistant.webhook": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Webhook resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Webhook resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UM[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Webhook resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + }, + "events": { + "type": "string", + "nullable": true, + "description": "The list of space-separated events that this Webhook is subscribed to." + }, + "webhook_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL associated with this Webhook." + }, + "webhook_method": { + "type": "string", + "nullable": true, + "description": "The method used when calling the webhook's URL." + } + } + } + }, + "securitySchemes": { + "accountSid_authToken": { + "type": "http", + "scheme": "basic" + } + } + }, + "info": { + "title": "Twilio - Autopilot", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.53.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Assistants/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "instance", + "dependentProperties": { + "field_types": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/FieldTypes" + }, + "tasks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks" + }, + "model_builds": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/ModelBuilds" + }, + "queries": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Queries" + }, + "style_sheet": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1None" + }, + "defaults": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1None" + }, + "dialogues": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Dialogues" + }, + "webhooks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Webhooks" + } + } + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Assistant" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Assistant resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchAssistant", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Assistant" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Assistant resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateAssistant", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateAssistantRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." + }, + "LogQueries": { + "type": "boolean", + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "Reserved." + }, + "CallbackEvents": { + "type": "string", + "description": "Reserved." + }, + "StyleSheet": { + "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)" + }, + "Defaults": { + "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks." + }, + "DevelopmentStage": { + "type": "string", + "description": "A string describing the state of the assistant." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Assistant" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Assistant resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteAssistant", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "list", + "dependentProperties": { + "field_types": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/FieldTypes" + }, + "tasks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks" + }, + "model_builds": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/ModelBuilds" + }, + "queries": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Queries" + }, + "style_sheet": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1None" + }, + "defaults": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1None" + }, + "dialogues": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Dialogues" + }, + "webhooks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Webhooks" + } + } + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Assistant" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListAssistantResponse", + "properties": { + "assistants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListAssistant", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Assistant" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateAssistant", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateAssistantRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." + }, + "LogQueries": { + "type": "boolean", + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "Reserved." + }, + "CallbackEvents": { + "type": "string", + "description": "Reserved." + }, + "StyleSheet": { + "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)" + }, + "Defaults": { + "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks." + } + } + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Defaults": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "data" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}", + "className": "defaults" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Defaults" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDefaults", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Defaults" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDefaults", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDefaultsRequest", + "properties": { + "Defaults": { + "description": "A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations." + } + } + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Dialogues/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "data" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Dialogue" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Dialogue resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.dialogue" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDialogue", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Dialogues": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "data" + ], + "pathType": "list", + "parent": "/Assistants/{Sid}" + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "field_type" + ], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Field" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Field resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchField", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Field" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Field resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteField", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "field_type" + ], + "pathType": "list", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Field" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListFieldResponse", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListField", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Field" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the new Field resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateField", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateFieldRequest", + "properties": { + "FieldType": { + "type": "string", + "description": "The Field Type of the new field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the `unique_name`, or the `sid` of a custom Field Type." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." + } + }, + "required": [ + "FieldType", + "UniqueName" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "instance", + "dependentProperties": { + "field_values": { + "mapping": { + "assistant_sid": "assistant_sid", + "field_type_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1FieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the FieldType resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchFieldType", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1FieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the FieldType resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateFieldType", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateFieldTypeRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1FieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the FieldType resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteFieldType", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/FieldTypes": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "list", + "dependentProperties": { + "field_values": { + "mapping": { + "assistant_sid": "assistant_sid", + "field_type_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1FieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListFieldTypeResponse", + "properties": { + "field_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListFieldType", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1FieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateFieldType", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateFieldTypeRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique." + }, + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." + } + }, + "required": [ + "UniqueName" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "value", + "language" + ], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1FieldValue" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "The SID of the Field Type associated with the Field Value to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the FieldValue resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchFieldValue", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1FieldValue" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "The SID of the Field Type associated with the Field Value to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the FieldValue resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteFieldValue", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "value", + "language" + ], + "pathType": "list", + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1FieldValue" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "The SID of the Field Type associated with the Field Value to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Language", + "in": "query", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListFieldValueResponse", + "properties": { + "field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListFieldValue", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1FieldValue" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the new resource.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "The SID of the Field Type associated with the Field Value.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateFieldValue", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateFieldValueRequest", + "properties": { + "Language": { + "type": "string", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`" + }, + "Value": { + "type": "string", + "description": "The Field Value data." + }, + "SynonymOf": { + "type": "string", + "description": "The string value that indicates which word the field value is a synonym of." + } + }, + "required": [ + "Language", + "Value" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "status", + "date_created" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1ModelBuild" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchModelBuild", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1ModelBuild" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateModelBuild", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateModelBuildRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1ModelBuild" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the ModelBuild resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteModelBuild", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/ModelBuilds": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "status", + "date_created" + ], + "pathType": "list", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1ModelBuild" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListModelBuildResponse", + "properties": { + "model_builds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListModelBuild", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1ModelBuild" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateModelBuild", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateModelBuildRequest", + "properties": { + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "The URL we should call using a POST method to send status information to your application." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource." + } + } + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Queries/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "query", + "status", + "language" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Query" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Query resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchQuery", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Query" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Query resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.query" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateQuery", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateQueryRequest", + "properties": { + "SampleSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query." + }, + "Status": { + "type": "string", + "description": "The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`" + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Query" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Query resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteQuery", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Queries": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "query", + "status", + "language" + ], + "pathType": "list", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Query" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Language", + "in": "query", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.", + "schema": { + "type": "string" + } + }, + { + "name": "ModelBuild", + "in": "query", + "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", + "schema": { + "type": "string" + } + }, + { + "name": "Status", + "in": "query", + "description": "The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`", + "schema": { + "type": "string" + } + }, + { + "name": "DialogueSid", + "in": "query", + "description": "The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListQueryResponse", + "properties": { + "queries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.query" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListQuery", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Query" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.query" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateQuery", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateQueryRequest", + "properties": { + "Language": { + "type": "string", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new query. For example: `en-US`." + }, + "Query": { + "type": "string", + "description": "The end-user's natural language input. It can be up to 2048 characters long." + }, + "Tasks": { + "type": "string", + "description": "The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task `unique_name` values. For example, `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to constrain the paths that a user can take." + }, + "ModelBuild": { + "type": "string", + "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried." + } + }, + "required": [ + "Language", + "Query" + ] + } + } + } + } + } + }, + "/v1/Assistants/Restore": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "list", + "mountName": "restore_assistant" + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1RestoreAssistant" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.restore_assistant" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateRestoreAssistant", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateRestoreAssistantRequest", + "properties": { + "Assistant": { + "type": "string", + "description": "The Twilio-provided string that uniquely identifies the Assistant resource to restore." + } + }, + "required": [ + "Assistant" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "tagged_text", + "language", + "source_channel" + ], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Sample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Sample resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchSample", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Sample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Sample resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateSample", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSampleRequest", + "properties": { + "Language": { + "type": "string", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`." + }, + "TaggedText": { + "type": "string", + "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." + }, + "SourceChannel": { + "type": "string", + "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Sample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Sample resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSample", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "tagged_text", + "language", + "source_channel" + ], + "pathType": "list", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Sample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Language", + "in": "query", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListSampleResponse", + "properties": { + "samples": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSample", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Sample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSample", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSampleRequest", + "properties": { + "Language": { + "type": "string", + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new sample. For example: `en-US`." + }, + "TaggedText": { + "type": "string", + "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging)." + }, + "SourceChannel": { + "type": "string", + "description": "The communication channel from which the new sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included." + } + }, + "required": [ + "Language", + "TaggedText" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/StyleSheet": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "data" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "Returns Style sheet JSON object for the Assistant", + "tags": [ + "AutopilotV1StyleSheet" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchStyleSheet", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Updates the style sheet for an Assistant identified by `assistant_sid`.", + "tags": [ + "AutopilotV1StyleSheet" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateStyleSheet", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateStyleSheetRequest", + "properties": { + "StyleSheet": { + "description": "The JSON string that describes the style sheet object." + } + } + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "instance", + "dependentProperties": { + "fields": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields" + }, + "samples": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples" + }, + "task_actions": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1None" + }, + "statistics": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1None" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Task" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Task resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchTask", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Task" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Task resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateTask", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateTaskRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the `sid` in the URL path to address the resource." + }, + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." + }, + "ActionsUrl": { + "type": "string", + "format": "uri", + "description": "The URL from which the Assistant can fetch actions." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Task" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Task resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteTask", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Tasks": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "friendly_name" + ], + "pathType": "list", + "dependentProperties": { + "fields": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields" + }, + "samples": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples" + }, + "task_actions": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1None" + }, + "statistics": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/v1None" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Task" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListTaskResponse", + "properties": { + "tasks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListTask", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Task" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateTask", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateTaskRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." + }, + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long." + }, + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task. It is optional and not unique." + }, + "ActionsUrl": { + "type": "string", + "format": "uri", + "description": "The URL from which the Assistant can fetch actions." + } + }, + "required": [ + "UniqueName" + ] + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "data" + ], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "mountName": "task_actions", + "className": "task_actions" + }, + "get": { + "description": "Returns JSON actions for the Task.", + "tags": [ + "AutopilotV1TaskActions" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to fetch were defined.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to fetch were defined.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchTaskActions", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", + "tags": [ + "AutopilotV1TaskActions" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to update were defined.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to update were defined.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateTaskActions", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateTaskActionsRequest", + "properties": { + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task." + } + } + } + } + } + } + } + }, + "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "samples_count", + "fields_count" + ], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "className": "task_statistics" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1TaskStatistics" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_statistics" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchTaskStatistics", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Webhooks/{Sid}": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "events", + "wehbook_url", + "webhook_method" + ], + "pathType": "instance", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Webhook" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Webhook resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchWebhook", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Webhook" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Webhook resource to update.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateWebhook", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateWebhookRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." + }, + "Events": { + "type": "string", + "description": "The list of space-separated events that this Webhook will subscribe to." + }, + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "The URL associated with this Webhook." + }, + "WebhookMethod": { + "type": "string", + "description": "The method to be used when calling the webhook's URL." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "AutopilotV1Webhook" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Webhook resource to delete.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteWebhook", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Assistants/{AssistantSid}/Webhooks": { + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "unique_name", + "events", + "wehbook_url", + "webhook_method" + ], + "pathType": "list", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "AutopilotV1Webhook" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListWebhookResponse", + "properties": { + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListWebhook", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "AutopilotV1Webhook" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateWebhook", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateWebhookRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length." + }, + "Events": { + "type": "string", + "description": "The list of space-separated events that this Webhook will subscribe to." + }, + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "The URL associated with this Webhook." + }, + "WebhookMethod": { + "type": "string", + "description": "The method to be used when calling the webhook's URL." + } + }, + "required": [ + "UniqueName", + "Events", + "WebhookUrl" + ] + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://autopilot.twilio.com" + } + ], + "tags": [ + { + "name": "AutopilotV1Assistant" + }, + { + "name": "AutopilotV1Defaults" + }, + { + "name": "AutopilotV1Dialogue" + }, + { + "name": "AutopilotV1Field" + }, + { + "name": "AutopilotV1FieldType" + }, + { + "name": "AutopilotV1FieldValue" + }, + { + "name": "AutopilotV1ModelBuild" + }, + { + "name": "AutopilotV1Query" + }, + { + "name": "AutopilotV1RestoreAssistant" + }, + { + "name": "AutopilotV1Sample" + }, + { + "name": "AutopilotV1StyleSheet" + }, + { + "name": "AutopilotV1Task" + }, + { + "name": "AutopilotV1TaskActions" + }, + { + "name": "AutopilotV1TaskStatistics" + }, + { + "name": "AutopilotV1Webhook" + } + ], + "x-maturity": [ + { + "name": "Preview", + "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index 597d6053..fed3273f 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -271,7 +271,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 3760eab2..47857708 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -31,35 +31,17 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. It can be used to address the resource in place of the resource's `sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -82,13 +64,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -143,13 +119,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -228,13 +198,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -307,13 +271,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -376,13 +334,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -428,24 +380,12 @@ "from": { "type": "string", "nullable": true, - "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The content of the message." }, "index": { "type": "integer", @@ -497,13 +437,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -568,13 +502,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -711,24 +639,12 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "role_sid": { "type": "string", @@ -741,13 +657,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -878,7 +788,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1934,12 +1844,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -2382,12 +2286,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index b99852ba..a205a3fc 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -43,24 +43,12 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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 application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -136,35 +124,17 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. It can be used to address the resource in place of the resource's `sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "type": { "type": "string", @@ -187,13 +157,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -334,13 +298,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -419,13 +377,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -498,13 +450,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -546,13 +492,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." } } }, @@ -585,13 +525,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "service_sid": { "type": "string", @@ -632,13 +566,7 @@ "last_updated_by": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable." }, "was_edited": { "type": "boolean", @@ -648,24 +576,12 @@ "from": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The content of the message." }, "index": { "type": "integer", @@ -679,13 +595,7 @@ }, "media": { "nullable": true, - "description": "An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -739,13 +649,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -810,13 +714,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -963,24 +861,12 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "role_sid": { "type": "string", @@ -993,13 +879,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1091,24 +971,12 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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 application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1278,7 +1146,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1337,12 +1205,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -3153,12 +3015,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -3662,12 +3518,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index 003ffd4a..9c14889f 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -31,35 +31,17 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. It can be used to address the resource in place of the resource's `sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "type": { "type": "string", @@ -82,13 +64,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -151,7 +127,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index 3113593f..8a311071 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -79,7 +79,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (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", @@ -142,7 +142,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (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." }, "approval_requests": { "nullable": true, @@ -197,7 +197,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (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." }, "legacy_template_name": { "type": "string", @@ -238,7 +238,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index 4401eca0..ef1b4cac 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -79,13 +79,7 @@ "address": { "type": "string", "nullable": true, - "description": "The unique address to be configured. The address can be a whatsapp address or phone number", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The unique address to be configured. The address can be a whatsapp address or phone number" }, "friendly_name": { "type": "string", @@ -247,35 +241,17 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. It can be used to address the resource in place of the resource's `sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -366,47 +342,23 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The channel specific identifier of the message's author. Defaults to `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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 the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -450,7 +402,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." } } }, @@ -590,34 +542,16 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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. A JSON parameter consisting of type and address fields of the participant.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -757,13 +691,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this credential, limited to 64 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The human-readable name of this credential, limited to 64 characters. Optional." }, "type": { "type": "string", @@ -842,23 +770,11 @@ "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. A JSON parameter consisting of type and address fields of the participant.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -871,35 +787,17 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -974,13 +872,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -1045,13 +937,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this service, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The human-readable name of this service, limited to 256 characters. Optional." }, "date_created": { "type": "string", @@ -1129,24 +1015,12 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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 application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1270,35 +1144,17 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. It can be used to address the resource in place of the resource's `sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -1397,47 +1253,23 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The channel specific identifier of the message's author. Defaults to `system`." }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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 the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -1481,7 +1313,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." } } }, @@ -1637,34 +1469,16 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters." }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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. A JSON parameter consisting of type and address fields of the participant.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1872,23 +1686,11 @@ "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. A JSON parameter consisting of type and address fields of the participant.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1901,35 +1703,17 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -2004,13 +1788,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "type": { "type": "string", @@ -2091,35 +1869,17 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "is_online": { "type": "boolean", @@ -2219,13 +1979,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_state": { "type": "string", @@ -2240,13 +1994,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -2274,13 +2022,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -2408,35 +2150,17 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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. If attributes have not been set, `{}` is returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." }, "is_online": { "type": "boolean", @@ -2536,13 +2260,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The human-readable name of this conversation, limited to 256 characters. Optional." }, "conversation_state": { "type": "string", @@ -2557,13 +2275,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -2591,13 +2303,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -2648,7 +2354,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -3877,7 +3583,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", @@ -6623,12 +6329,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -7542,7 +7242,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index bb28c205..8882a42e 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -223,7 +223,7 @@ "schema_version": { "type": "integer", "nullable": true, - "description": "The schema version that the Subscription should use." + "description": "The schema version that the subscription should use." }, "subscription_sid": { "type": "string", @@ -320,7 +320,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -442,7 +442,7 @@ ], "operationId": "ListEventType", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -497,7 +497,7 @@ ], "operationId": "FetchEventType", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -557,7 +557,7 @@ ], "operationId": "FetchSchema", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -703,7 +703,7 @@ ], "operationId": "ListSchemaVersion", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -768,7 +768,7 @@ ], "operationId": "FetchSchemaVersion", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -843,7 +843,7 @@ ], "operationId": "FetchSink", "x-maturity": [ - "GA" + "Beta" ] }, "delete": { @@ -877,7 +877,7 @@ ], "operationId": "DeleteSink", "x-maturity": [ - "GA" + "Beta" ] }, "post": { @@ -918,7 +918,7 @@ ], "operationId": "UpdateSink", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -998,7 +998,7 @@ ], "operationId": "CreateSink", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -1140,7 +1140,7 @@ ], "operationId": "ListSink", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -1197,7 +1197,7 @@ ], "operationId": "CreateSinkTest", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -1254,7 +1254,7 @@ ], "operationId": "CreateSinkValidate", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -1283,7 +1283,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent Subscription", + "description": "Event subscribed to in the parent subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -1400,11 +1400,11 @@ ], "operationId": "ListSubscribedEvent", "x-maturity": [ - "GA" + "Beta" ] }, "post": { - "description": "Add an event type to a Subscription.", + "description": "Create a new Subscribed Event type for the subscription", "tags": [ "EventsV1SubscribedEvent" ], @@ -1441,7 +1441,7 @@ ], "operationId": "CreateSubscribedEvent", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -1456,7 +1456,7 @@ }, "SchemaVersion": { "type": "integer", - "description": "The schema version that the Subscription should use." + "description": "The schema version that the subscription should use." } }, "required": [ @@ -1474,7 +1474,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent Subscription", + "description": "Event subscribed to in the parent subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -1532,7 +1532,7 @@ ], "operationId": "FetchSubscribedEvent", "x-maturity": [ - "GA" + "Beta" ] }, "post": { @@ -1582,7 +1582,7 @@ ], "operationId": "UpdateSubscribedEvent", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -1593,7 +1593,7 @@ "properties": { "SchemaVersion": { "type": "integer", - "description": "The schema version that the Subscription should use." + "description": "The schema version that the subscription should use." } } } @@ -1602,7 +1602,7 @@ } }, "delete": { - "description": "Remove an event type from a Subscription.", + "description": "Remove an event type from a subscription.", "tags": [ "EventsV1SubscribedEvent" ], @@ -1641,7 +1641,7 @@ ], "operationId": "DeleteSubscribedEvent", "x-maturity": [ - "GA" + "Beta" ] } }, @@ -1775,7 +1775,7 @@ ], "operationId": "ListSubscription", "x-maturity": [ - "GA" + "Beta" ] }, "post": { @@ -1802,7 +1802,7 @@ ], "operationId": "CreateSubscription", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -1902,7 +1902,7 @@ ], "operationId": "FetchSubscription", "x-maturity": [ - "GA" + "Beta" ] }, "post": { @@ -1943,7 +1943,7 @@ ], "operationId": "UpdateSubscription", "x-maturity": [ - "GA" + "Beta" ], "requestBody": { "content": { @@ -2000,7 +2000,7 @@ ], "operationId": "DeleteSubscription", "x-maturity": [ - "GA" + "Beta" ] } } @@ -2038,8 +2038,8 @@ ], "x-maturity": [ { - "name": "GA", - "description": "This product is Generally Available." + "name": "Beta", + "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 52d66c90..2d0e5794 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -327,10 +327,6 @@ "citrix_voice_vdi": { "nullable": true, "description": "Citrix voice vdi configuration and settings." - }, - "offline_config": { - "nullable": true, - "description": "Presence and presence ttl configuration" } } }, @@ -376,13 +372,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "chat_service_sid": { "type": "string", @@ -1038,7 +1028,7 @@ "type": "string", "$ref": "#/components/schemas/interaction_channel_enum_type", "nullable": true, - "description": "The Interaction Channel's type. Can be: `sms`, `email`, `chat`, `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type" + "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", @@ -1213,32 +1203,6 @@ "unknown" ] }, - "flex.v1.provisioning_status": { - "type": "object", - "properties": { - "status": { - "type": "string", - "$ref": "#/components/schemas/provisioning_status_enum_status", - "nullable": true, - "description": "Email Provisioning Status" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The absolute URL of the resource." - } - } - }, - "provisioning_status_enum_status": { - "type": "string", - "enum": [ - "active", - "in-progress", - "not-configured", - "failed" - ] - }, "flex.v1.web_channel": { "type": "object", "properties": { @@ -1313,7 +1277,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1699,12 +1663,6 @@ "description": "The `friendly_name` of the Flex Flow resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -5236,48 +5194,6 @@ } } }, - "/v1/account/provision/status": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "Status for email provisioning", - "x-twilio": { - "defaultOutputProperties": [ - "status" - ], - "pathType": "instance", - "mountName": "provisioning_status" - }, - "get": { - "description": "", - "tags": [ - "FlexV1ProvisioningStatus" - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flex.v1.provisioning_status" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchProvisioningStatus", - "x-maturity": [ - "Beta" - ] - } - }, "/v1/WebChannels": { "servers": [ { @@ -5677,9 +5593,6 @@ { "name": "FlexV1InteractionChannelParticipant" }, - { - "name": "FlexV1ProvisioningStatus" - }, { "name": "FlexV1WebChannel" } @@ -5689,10 +5602,6 @@ "name": "GA", "description": "This product is Generally Available." }, - { - "name": "Beta", - "description": "PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution." - }, { "name": "Preview", "description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact." diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index bfe09f4a..938c1184 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -40,7 +40,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index b997cf0c..ca9c7a14 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -15,24 +15,12 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the User." }, "avatar": { "type": "string", @@ -86,7 +74,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index 44f7ab3a..90f07b1c 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -92,7 +92,8 @@ "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The URL of this resource." } } }, @@ -224,23 +225,11 @@ }, "from": { "nullable": true, - "description": "The calling party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The calling party." }, "to": { "nullable": true, - "description": "The called party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The called party." }, "carrier_edge": { "nullable": true, @@ -378,13 +367,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "Custom label for the conference resource, up to 64 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Custom label for the conference resource, up to 64 characters." }, "create_time": { "type": "string", @@ -572,13 +555,7 @@ "label": { "type": "string", "nullable": true, - "description": "The user-specified label of this participant.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The user-specified label of this participant." }, "conference_sid": { "type": "string", @@ -613,24 +590,12 @@ "from": { "type": "string", "nullable": true, - "description": "Caller ID of the calling party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Caller ID of the calling party." }, "to": { "type": "string", "nullable": true, - "description": "Called party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Called party." }, "call_status": { "type": "string", @@ -1025,23 +990,11 @@ }, "from": { "nullable": true, - "description": "The calling party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The calling party." }, "to": { "nullable": true, - "description": "The called party.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The called party." }, "carrier_edge": { "nullable": true, @@ -1549,7 +1502,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1918,12 +1871,6 @@ "description": "A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -1932,12 +1879,6 @@ "description": "A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -2320,12 +2261,6 @@ "description": "Custom label for the conference resource, up to 64 characters.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -2625,12 +2560,6 @@ "description": "User-specified label for a participant.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 5cb80007..4dfc9187 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -108,10 +108,6 @@ "nullable": true, "description": "List of text extraction results. This might be available on classify-extract model outputs." }, - "text_generation_results": { - "nullable": true, - "description": "Output of a text generation operator for example Conversation Sumamary." - }, "transcript_sid": { "type": "string", "minLength": 34, @@ -164,13 +160,7 @@ "transcript": { "type": "string", "nullable": true, - "description": "Transcript text.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "Transcript text." }, "sid": { "type": "string", @@ -215,7 +205,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." + "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." }, "date_created": { "type": "string", @@ -333,7 +323,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." + "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." }, "language_code": { "type": "string", @@ -413,7 +403,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -890,7 +880,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." + "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." }, "FriendlyName": { "type": "string", @@ -1169,7 +1159,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." + "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." }, "FriendlyName": { "type": "string", diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index 62267b8f..9766c442 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -680,7 +680,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 3a3ec755..c2441e8c 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -989,7 +989,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 19875ec9..bdf53412 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -6,47 +6,23 @@ "properties": { "caller_name": { "nullable": true, - "description": "The name of the phone number's owner. If `null`, that information was not available.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The phone number, in national format." }, "carrier": { "nullable": true, @@ -54,13 +30,7 @@ }, "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).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -99,7 +69,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -114,8 +84,7 @@ "defaultOutputProperties": [ "caller_name", "country_code", - "carrier", - "url" + "carrier" ], "pathType": "instance" }, @@ -133,12 +102,6 @@ "type": "string", "format": "phone-number" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -147,12 +110,6 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -175,12 +132,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index 75b37821..ed63418b 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -12,36 +12,18 @@ "country_code": { "type": "string", "nullable": true, - "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers)." }, "valid": { "type": "boolean", @@ -59,13 +41,7 @@ }, "caller_name": { "nullable": true, - "description": "An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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, @@ -147,7 +123,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -181,12 +157,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -203,12 +173,6 @@ "description": "The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -282,12 +246,6 @@ "description": "User\u2019s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } } }, { @@ -296,12 +254,6 @@ "description": "User\u2019s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index 0f152c88..479bdebe 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -35,13 +35,7 @@ "extension": { "type": "string", "nullable": true, - "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`" }, "extension_context": { "type": "string", @@ -421,7 +415,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index 9c540761..e20691bb 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -368,8 +368,7 @@ "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "The absolute URL of the ChannelSender resource." + "nullable": true } } }, @@ -1143,11 +1142,6 @@ "nullable": true, "description": "The date and time when the ability to edit a rejected verification expires." }, - "edit_allowed": { - "type": "boolean", - "nullable": true, - "description": "If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not." - }, "resource_links": { "nullable": true, "description": "The URLs of the documents associated with the Tollfree Verification resource." @@ -1378,7 +1372,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -4532,50 +4526,12 @@ "type": "string", "format": "phone-number", "description": "The phone number of the contact for the business or organization using the Tollfree number." - }, - "EditReason": { - "type": "string", - "description": "Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'." } } } } } } - }, - "delete": { - "description": "", - "tags": [ - "MessagingV1TollfreeVerification" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The unique string to identify Tollfree Verification.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HH[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteTollfreeVerification", - "x-maturity": [ - "Beta" - ] } }, "/v1/Tollfree/Verifications": { diff --git a/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index db40ea73..62dee660 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -273,7 +273,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index afda21a6..23b10d34 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -341,7 +341,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 575556cb..22e64e19 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -61,13 +61,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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", @@ -77,13 +71,7 @@ "address": { "type": "string", "nullable": true, - "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 120 - } - } + "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", @@ -91,13 +79,7 @@ "type": "string" }, "nullable": true, - "description": "The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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", @@ -226,13 +208,7 @@ "type": "string" }, "nullable": true, - "description": "The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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", @@ -240,13 +216,7 @@ "type": "string" }, "nullable": true, - "description": "The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } - } + "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", @@ -275,13 +245,7 @@ "body": { "type": "string", "nullable": true, - "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "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", @@ -396,7 +360,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/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", @@ -478,7 +442,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -756,12 +720,6 @@ "items": { "type": "string" } - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 120 - } } }, { @@ -1317,7 +1275,7 @@ "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref)." }, "Sms": { - "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." + "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." }, "FacebookMessenger": { "description": "Deprecated." @@ -1472,7 +1430,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", @@ -1815,7 +1773,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", diff --git a/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index 13343af7..41b5e32c 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -154,7 +154,7 @@ "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Port In request. This is a unique identifier of the port in request." + "description": "The SID of the Port In request, It is the request identifier" }, "url": { "type": "string", @@ -163,75 +163,6 @@ } } }, - "numbers.v1.porting_port_in_fetch": { - "type": "object", - "properties": { - "port_in_request_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KW[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The SID of the Port In request. This is a unique identifier of the port in request." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of this Port In request" - }, - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The Account SID that the numbers will be added to after they are ported into Twilio." - }, - "notification_emails": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails." - }, - "target_port_in_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation." - }, - "target_port_in_time_range_start": { - "type": "string", - "nullable": true, - "description": "Minimum hour in the future needs to be established with the Ops team for validation." - }, - "target_port_in_time_range_end": { - "type": "string", - "nullable": true, - "description": "Maximum hour in the future needs to be established with the Ops team for validation." - }, - "losing_carrier_information": { - "nullable": true, - "description": "The information for the losing carrier. " - }, - "phone_numbers": { - "type": "array", - "items": {}, - "nullable": true, - "description": "The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212)." - }, - "documents": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true, - "description": "The list of documents SID referencing a utility bills" - } - } - }, "numbers.v1.porting_portability": { "type": "object", "properties": { @@ -329,7 +260,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -550,63 +481,6 @@ "mountName": "porting_port_ins" } }, - "/v1/Porting/PortIn/{PortInRequestSid}": { - "servers": [ - { - "url": "https://numbers.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "port_in_request_sid" - ], - "pathType": "instance", - "mountName": "porting_port_ins", - "className": "porting_port_in_fetch" - }, - "get": { - "description": "Fetch a port in request by SID", - "tags": [ - "NumbersV1PortingPortInFetch" - ], - "parameters": [ - { - "name": "PortInRequestSid", - "in": "path", - "description": "The SID of the Port In request. This is a unique identifier of the port in request.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KW[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/numbers.v1.porting_port_in_fetch" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchPortingPortInFetch", - "x-maturity": [ - "Beta" - ] - } - }, "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { "servers": [ { @@ -683,9 +557,6 @@ { "name": "NumbersV1PortingBulkPortability" }, - { - "name": "NumbersV1PortingPortInFetch" - }, { "name": "NumbersV1PortingPortability" } diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index f53d08a5..919f8f24 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -29,13 +29,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email that this AuthorizationDocument will be sent to for signing." }, "cc_emails": { "type": "array", @@ -43,13 +37,7 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." }, "date_created": { "type": "string", @@ -105,24 +93,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 128 character string that is a human-readable text that describes this resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A 128 character string that is a human-readable text that describes this resource." }, "notification_email": { "type": "string", "nullable": true, - "description": "Email address used for send notifications about this Bulk hosted number request.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email address used for send notifications about this Bulk hosted number request." }, "date_created": { "type": "string", @@ -151,13 +127,7 @@ "type": "array", "items": {}, "nullable": true, - "description": "Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'." } } }, @@ -454,13 +424,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 128 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A human readable description of this resource, up to 128 characters." }, "status": { "type": "string", @@ -488,13 +452,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -502,13 +460,7 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, "contact_title": { "type": "string", @@ -567,13 +519,7 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -750,13 +696,7 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -781,13 +721,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 128 character string that is a human-readable text that describes this resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A 128 character string that is a human-readable text that describes this resource." }, "status": { "type": "string", @@ -815,13 +749,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -829,13 +757,7 @@ "type": "string" }, "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, "url": { "type": "string", @@ -1119,13 +1041,7 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1214,7 +1130,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1344,12 +1260,6 @@ "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -2354,12 +2264,6 @@ "description": "A human readable description of this resource, up to 128 characters.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -3303,12 +3207,6 @@ "schema": { "type": "string", "format": "phone-number" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -3328,12 +3226,6 @@ "description": "A human readable description of this resource, up to 128 characters.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_oauth_v1.json b/spec/json/twilio_oauth_v1.json new file mode 100644 index 00000000..be87580f --- /dev/null +++ b/spec/json/twilio_oauth_v1.json @@ -0,0 +1,577 @@ +{ + "components": { + "schemas": { + "oauth.v1.certs": { + "type": "object", + "properties": { + "keys": { + "nullable": true, + "description": "A collection of certificates where are signed Twilio-issued tokens." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "oauth.v1.device_code": { + "type": "object", + "properties": { + "device_code": { + "type": "string", + "nullable": true, + "description": "The device verification code." + }, + "user_code": { + "type": "string", + "nullable": true, + "description": "The verification code which end user uses to verify authorization request." + }, + "verification_uri": { + "type": "string", + "nullable": true, + "description": "The URI that the end user visits to verify authorization request." + }, + "verification_uri_complete": { + "type": "string", + "nullable": true, + "description": "The URI with user_code that the end-user alternatively visits to verify authorization request." + }, + "expires_in": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "The expiration time of the device_code and user_code in seconds." + }, + "interval": { + "type": "integer", + "nullable": true, + "description": "The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint." + } + } + }, + "oauth.v1.openid_discovery": { + "type": "object", + "properties": { + "issuer": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the party that will create the token and sign it with its private key." + }, + "authorization_endpoint": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The endpoint that validates all authorization requests." + }, + "device_authorization_endpoint": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The endpoint that validates all device code related authorization requests." + }, + "token_endpoint": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the token endpoint. After a client has received an authorization code, that code is presented to the token endpoint and exchanged for an identity token, an access token, and a refresh token." + }, + "userinfo_endpoint": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the user info endpoint, which returns user profile information to a client. Keep in mind that the user info endpoint returns only the information that has been requested." + }, + "revocation_endpoint": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The endpoint used to revoke access or refresh tokens issued by the authorization server." + }, + "jwk_uri": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of your JSON Web Key Set. This set is a collection of JSON Web Keys, a standard method for representing cryptographic keys in a JSON structure." + }, + "response_type_supported": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A collection of response type supported by authorization server." + }, + "subject_type_supported": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A collection of subject by authorization server." + }, + "id_token_signing_alg_values_supported": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A collection of JWS signing algorithms supported by authorization server to sign identity token." + }, + "scopes_supported": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A collection of scopes supported by authorization server for identity token" + }, + "claims_supported": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "A collection of claims supported by authorization server for identity token" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "oauth.v1.token": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "nullable": true, + "description": "Token which carries the necessary information to access a Twilio resource directly." + }, + "refresh_token": { + "type": "string", + "nullable": true, + "description": "Token which carries the information necessary to get a new access token." + }, + "id_token": { + "type": "string", + "nullable": true + }, + "refresh_token_expires_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "access_token_expires_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + } + } + }, + "oauth.v1.user_info": { + "type": "object", + "properties": { + "user_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^US[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The URL of the party that will create the token and sign it with its private key." + }, + "first_name": { + "type": "string", + "nullable": true, + "description": "The first name of the end-user." + }, + "last_name": { + "type": "string", + "nullable": true, + "description": "The last name of the end-user." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name of the end-user." + }, + "email": { + "type": "string", + "nullable": true, + "description": "The end-user's preferred email address." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + } + }, + "securitySchemes": { + "accountSid_authToken": { + "type": "http", + "scheme": "basic" + } + } + }, + "info": { + "title": "Twilio - Oauth", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.53.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/certs": { + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "keys" + ], + "pathType": "instance", + "mountName": "oauth" + }, + "get": { + "description": "Fetches public JWKs", + "tags": [ + "OauthV1Oauth" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oauth.v1.certs" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchCerts", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/device/code": { + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "device_code", + "user_code", + "verification_uri", + "verification_uri_complete", + "expires_in", + "interval" + ], + "pathType": "list", + "mountName": "device_code" + }, + "post": { + "description": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", + "tags": [ + "OauthV1DeviceCode" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oauth.v1.device_code" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeviceCode", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeviceCodeRequest", + "properties": { + "ClientSid": { + "type": "string", + "description": "A 34 character string that uniquely identifies this OAuth App." + }, + "Scopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An Array of scopes for authorization request" + }, + "Audiences": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of intended audiences for token requests" + } + }, + "required": [ + "ClientSid", + "Scopes" + ] + } + } + } + } + } + }, + "/v1/.well-known/openid-configuration": { + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "issuer", + "authorization_endpoint", + "device_authorization_endpoint", + "token_endpoint", + "userinfo_endpoint", + "revocation_endpoint", + "jwk_uri", + "response_type_supported", + "subject_type_supported", + "id_token_signing_alg_values_supported", + "scopes_supported", + "claims_supported" + ], + "pathType": "instance", + "mountName": "openid_discovery" + }, + "get": { + "description": "Fetch configuration details about the OpenID Connect Authorization Server", + "tags": [ + "OauthV1OpenidDiscovery" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oauth.v1.openid_discovery" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchOpenidDiscovery", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/token": { + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "access_token", + "access_token_expires_at" + ], + "pathType": "list" + }, + "post": { + "description": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", + "tags": [ + "OauthV1Token" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oauth.v1.token" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateToken", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateTokenRequest", + "properties": { + "GrantType": { + "type": "string", + "description": "Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token." + }, + "ClientSid": { + "type": "string", + "description": "A 34 character string that uniquely identifies this OAuth App." + }, + "ClientSecret": { + "type": "string", + "description": "The credential for confidential OAuth App." + }, + "Code": { + "type": "string", + "description": "JWT token related to the authorization code grant type." + }, + "CodeVerifier": { + "type": "string", + "description": "A code which is generation cryptographically." + }, + "DeviceCode": { + "type": "string", + "description": "JWT token related to the device code grant type." + }, + "RefreshToken": { + "type": "string", + "description": "JWT token related to the refresh token grant type." + }, + "DeviceId": { + "type": "string", + "description": "The Id of the device associated with the token (refresh token)." + } + }, + "required": [ + "GrantType", + "ClientSid" + ] + } + } + } + } + } + }, + "/v1/userinfo": { + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "user_sid" + ], + "pathType": "instance", + "mountName": "user_info" + }, + "get": { + "description": "Retrieves the consented UserInfo and other claims about the logged-in subject (end-user).", + "tags": [ + "OauthV1UserInfo" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oauth.v1.user_info" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUserInfo", + "x-maturity": [ + "GA" + ] + } + } + }, + "servers": [ + { + "url": "https://oauth.twilio.com" + } + ], + "tags": [ + { + "name": "OauthV1DeviceCode" + }, + { + "name": "OauthV1Oauth" + }, + { + "name": "OauthV1OpenidDiscovery" + }, + { + "name": "OauthV1Token" + }, + { + "name": "OauthV1UserInfo" + } + ], + "x-maturity": [ + { + "name": "GA", + "description": "This product is Generally Available." + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index 8dc73115..5dc360ff 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -351,13 +351,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email that this AuthorizationDocument will be sent to for signing." }, "cc_emails": { "type": "array", @@ -365,13 +359,7 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." }, "date_created": { "type": "string", @@ -479,24 +467,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 64 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A human readable description of this resource, up to 64 characters." }, "unique_name": { "type": "string", "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -529,13 +505,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -543,13 +513,7 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" }, "verification_type": { "type": "string", @@ -683,24 +647,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 64 character string that is a human-readable text that describes this resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A 64 character string that is a human-readable text that describes this resource." }, "unique_name": { "type": "string", "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -733,13 +685,7 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Email of the owner of this phone number that is being hosted." }, "cc_emails": { "type": "array", @@ -747,13 +693,7 @@ "type": "string" }, "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." }, "url": { "type": "string", @@ -1556,135 +1496,231 @@ } } }, - "preview.wireless.command": { + "preview.understand.assistant": { "type": "object", "properties": { - "sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DC[0-9a-fA-F]{32}$", - "nullable": true - }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "nullable": true, + "description": "The unique ID of the Account that created this Assistant." }, - "device_sid": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + }, + "latest_model_build_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID (Sid) of the latest model build. Null if no model has been built." + }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true }, - "sim_sid": { + "log_queries": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter." + }, + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." }, - "command": { + "unique_name": { "type": "string", - "nullable": true + "nullable": true, + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long." }, - "command_mode": { + "url": { "type": "string", + "format": "uri", "nullable": true }, - "status": { + "callback_url": { "type": "string", - "nullable": true + "format": "uri", + "nullable": true, + "description": "A user-provided URL to send event callbacks to." }, - "direction": { + "callback_events": { "type": "string", - "nullable": true - }, - "date_created": { + "nullable": true, + "description": "Space-separated list of callback events that will trigger callbacks." + } + } + }, + "preview.understand.assistant.assistant_fallback_actions": { + "type": "object", + "properties": { + "account_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "date_updated": { + "assistant_sid": { "type": "string", - "format": "date-time", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true + }, + "data": { + "nullable": true } } }, - "preview.wireless.rate_plan": { + "preview.understand.assistant.assistant_initiation_actions": { "type": "object", "properties": { - "sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "nullable": true - }, - "unique_name": { - "type": "string", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true }, - "account_sid": { + "assistant_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^UA[0-9a-fA-F]{32}$", "nullable": true }, - "friendly_name": { + "url": { "type": "string", + "format": "uri", "nullable": true }, - "data_enabled": { - "type": "boolean", + "data": { "nullable": true - }, - "data_metering": { + } + } + }, + "preview.understand.assistant.dialogue": { + "type": "object", + "properties": { + "account_sid": { "type": "string", - "nullable": true - }, - "data_limit": { - "type": "integer", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field." }, - "messaging_enabled": { - "type": "boolean", - "nullable": true + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." }, - "voice_enabled": { - "type": "boolean", - "nullable": true + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UK[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Dialogue" }, - "national_roaming_enabled": { - "type": "boolean", - "nullable": true + "data": { + "nullable": true, + "description": "The dialogue memory object as json" }, - "international_roaming": { - "type": "array", - "items": { - "type": "string" - }, + "url": { + "type": "string", + "format": "uri", "nullable": true + } + } + }, + "preview.understand.assistant.task.field": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field." }, "date_created": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The date that this resource was created" }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The date that this resource was last updated" + }, + "field_type": { + "type": "string", + "nullable": true, + "description": "The Field Type of this field. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or sid of a custom Field Type." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Task associated with this Field." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UE[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." }, "url": { "type": "string", @@ -1693,204 +1729,883 @@ } } }, - "preview.wireless.sim": { + "preview.understand.assistant.field_type": { "type": "object", "properties": { - "sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field Type." }, - "unique_name": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" + }, + "friendly_name": { "type": "string", + "nullable": true, + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + }, + "links": { + "type": "object", + "format": "uri-map", "nullable": true }, - "account_sid": { + "assistant_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Assistant." }, - "rate_plan_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^WP[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^UB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." }, - "friendly_name": { + "unique_name": { "type": "string", - "nullable": true + "nullable": true, + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." }, - "iccid": { + "url": { "type": "string", + "format": "uri", "nullable": true - }, - "e_id": { + } + } + }, + "preview.understand.assistant.field_type.field_value": { + "type": "object", + "properties": { + "account_sid": { "type": "string", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field Value." }, - "status": { + "date_created": { "type": "string", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" }, - "commands_callback_url": { + "date_updated": { "type": "string", - "format": "uri", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" }, - "commands_callback_method": { + "field_type_sid": { "type": "string", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^UB[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Field Type associated with this Field Value." }, - "sms_fallback_method": { + "language": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true + "nullable": true, + "description": "An ISO language-country string of the value." }, - "sms_fallback_url": { + "assistant_sid": { "type": "string", - "format": "uri", - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Assistant." }, - "sms_method": { + "sid": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." }, - "sms_url": { + "value": { + "type": "string", + "nullable": true, + "description": "The Field Value itself." + }, + "url": { "type": "string", "format": "uri", "nullable": true }, - "voice_fallback_method": { + "synonym_of": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true + "minLength": 34, + "maxLength": 34, + "pattern": "^UC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." + } + } + }, + "preview.understand.assistant.model_build": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Model Build." }, - "voice_fallback_url": { + "date_created": { "type": "string", - "format": "uri", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" }, - "voice_method": { + "date_updated": { "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "nullable": true + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" }, - "voice_url": { + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." + }, + "status": { + "type": "string", + "$ref": "#/components/schemas/model_build_enum_status", + "nullable": true, + "description": "A string that described the model build status. The values can be: enqueued, building, completed, failed" + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "url": { "type": "string", "format": "uri", "nullable": true }, + "build_duration": { + "type": "integer", + "nullable": true, + "description": "The time in seconds it took to build the model." + }, + "error_code": { + "type": "integer", + "nullable": true + } + } + }, + "model_build_enum_status": { + "type": "string", + "enum": [ + "enqueued", + "building", + "completed", + "failed", + "canceled" + ] + }, + "preview.understand.assistant.query": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Query." + }, "date_created": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The date that this resource was created" }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true + "nullable": true, + "description": "The date that this resource was last updated" + }, + "results": { + "nullable": true, + "description": "The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields." + }, + "language": { + "type": "string", + "nullable": true, + "description": "An ISO language-country string of the sample." + }, + "model_build_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UG[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Model Build queried." + }, + "query": { + "type": "string", + "nullable": true, + "description": "The end-user's natural language input." + }, + "sample_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "nullable": true, + "description": "An optional reference to the Sample created from this query." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." + }, + "status": { + "type": "string", + "nullable": true, + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" }, "url": { "type": "string", "format": "uri", "nullable": true }, - "links": { - "type": "object", - "format": "uri-map", - "nullable": true + "source_channel": { + "type": "string", + "nullable": true, + "description": "The communication channel where this end-user input came from" } } }, - "preview.wireless.sim.usage": { + "preview.understand.assistant.task.sample": { "type": "object", "properties": { - "sim_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^DE[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Sample." }, - "sim_unique_name": { + "date_created": { "type": "string", - "nullable": true + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" }, - "account_sid": { + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" + }, + "task_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Task associated with this Sample." }, - "period": { - "nullable": true + "language": { + "type": "string", + "nullable": true, + "description": "An ISO language-country string of the sample." }, - "commands_usage": { - "nullable": true + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Assistant." }, - "commands_costs": { - "nullable": true + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." }, - "data_usage": { - "nullable": true + "tagged_text": { + "type": "string", + "nullable": true, + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." }, - "data_costs": { + "url": { + "type": "string", + "format": "uri", "nullable": true }, + "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" + } + } + }, + "preview.understand.assistant.style_sheet": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Assistant" + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Assistant" + }, "url": { "type": "string", "format": "uri", "nullable": true + }, + "data": { + "nullable": true, + "description": "The JSON style sheet object" } } - } - }, - "securitySchemes": { - "accountSid_authToken": { - "type": "http", - "scheme": "basic" - } - } - }, + }, + "preview.understand.assistant.task": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Task." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was created" + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date that this resource was last updated" + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Assistant." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "A 34 character string that uniquely identifies this resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "actions_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "User-provided HTTP endpoint where from the assistant fetches actions" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "preview.understand.assistant.task.task_actions": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Task." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "data": { + "nullable": true + } + } + }, + "preview.understand.assistant.task.task_statistics": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Account that created this Field." + }, + "assistant_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UA[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the parent Assistant." + }, + "task_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UD[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique ID of the Task associated with this Field." + }, + "samples_count": { + "type": "integer", + "nullable": true, + "description": "The total number of Samples associated with this Task." + }, + "fields_count": { + "type": "integer", + "nullable": true, + "description": "The total number of Fields associated with this Task." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "preview.wireless.command": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DC[0-9a-fA-F]{32}$", + "nullable": true + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true + }, + "device_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true + }, + "sim_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true + }, + "command": { + "type": "string", + "nullable": true + }, + "command_mode": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "nullable": true + }, + "direction": { + "type": "string", + "nullable": true + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "preview.wireless.rate_plan": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "nullable": true + }, + "unique_name": { + "type": "string", + "nullable": true + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true + }, + "friendly_name": { + "type": "string", + "nullable": true + }, + "data_enabled": { + "type": "boolean", + "nullable": true + }, + "data_metering": { + "type": "string", + "nullable": true + }, + "data_limit": { + "type": "integer", + "nullable": true + }, + "messaging_enabled": { + "type": "boolean", + "nullable": true + }, + "voice_enabled": { + "type": "boolean", + "nullable": true + }, + "national_roaming_enabled": { + "type": "boolean", + "nullable": true + }, + "international_roaming": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + }, + "preview.wireless.sim": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true + }, + "unique_name": { + "type": "string", + "nullable": true + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true + }, + "rate_plan_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WP[0-9a-fA-F]{32}$", + "nullable": true + }, + "friendly_name": { + "type": "string", + "nullable": true + }, + "iccid": { + "type": "string", + "nullable": true + }, + "e_id": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "nullable": true + }, + "commands_callback_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "commands_callback_method": { + "type": "string", + "nullable": true + }, + "sms_fallback_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true + }, + "sms_fallback_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "sms_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true + }, + "sms_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "voice_fallback_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true + }, + "voice_fallback_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "voice_method": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true + }, + "voice_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true + } + } + }, + "preview.wireless.sim.usage": { + "type": "object", + "properties": { + "sim_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true + }, + "sim_unique_name": { + "type": "string", + "nullable": true + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true + }, + "period": { + "nullable": true + }, + "commands_usage": { + "nullable": true + }, + "commands_costs": { + "nullable": true + }, + "data_usage": { + "nullable": true + }, + "data_costs": { + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + } + } + }, + "securitySchemes": { + "accountSid_authToken": { + "type": "http", + "scheme": "basic" + } + } + }, "info": { "title": "Twilio - Preview", "description": "This is the public Twilio REST API.", @@ -1900,15 +2615,3432 @@ "url": "https://support.twilio.com", "email": "support@twilio.com" }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.53.0" + }, + "openapi": "3.0.1", + "paths": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Fleets/{Sid}" + }, + "get": { + "description": "Fetch information about a specific Certificate credential in the Fleet.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesCertificate", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesCertificate", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDeployedDevicesCertificate", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesCertificateRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Fleets/{Sid}" + }, + "post": { + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesCertificate", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesCertificateRequest", + "properties": { + "CertificateData": { + "type": "string", + "description": "Provides a URL encoded representation of the public certificate in PEM format." + }, + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + } + }, + "required": [ + "CertificateData" + ] + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesCertificate" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "DeviceSid", + "in": "query", + "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDeployedDevicesCertificateResponse", + "properties": { + "certificates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesCertificate", + "x-maturity": [ + "Preview" + ] + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Fleets/{Sid}" + }, + "get": { + "description": "Fetch information about a specific Deployment in the Fleet.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesDeployment", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesDeployment", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDeployedDevicesDeployment", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesDeploymentRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" + }, + "SyncServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Fleets/{Sid}" + }, + "post": { + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesDeployment", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeploymentRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." + }, + "SyncServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Deployments belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesDeployment" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDeployedDevicesDeploymentResponse", + "properties": { + "deployments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesDeployment", + "x-maturity": [ + "Preview" + ] + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Fleets/{Sid}" + }, + "get": { + "description": "Fetch information about a specific Device in the Fleet.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesDevice", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesDevice", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDeployedDevicesDevice", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesDeviceRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + }, + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + }, + "DeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + }, + "Enabled": { + "type": "boolean", + "description": "" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Fleets/{Sid}" + }, + "post": { + "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesDevice", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeviceRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + }, + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + }, + "DeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + }, + "Enabled": { + "type": "boolean", + "description": "" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Devices belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "DeploymentSid", + "in": "query", + "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDeployedDevicesDeviceResponse", + "properties": { + "devices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesDevice", + "x-maturity": [ + "Preview" + ] + } + }, + "/DeployedDevices/Fleets/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "dependentProperties": { + "devices": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" + }, + "deployments": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + }, + "certificates": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + } + } + }, + "get": { + "description": "Fetch information about a specific Fleet in your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesFleet", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesFleet", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update the friendly name property of a specific Fleet in your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDeployedDevicesFleet", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesFleetRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + }, + "DefaultDeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "devices": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" + }, + "deployments": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + }, + "certificates": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + } + } + }, + "post": { + "description": "Create a new Fleet for scoping of deployed devices within your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesFleet", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesFleetRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Fleets belonging to your account.", + "tags": [ + "PreviewDeployedDevicesFleet" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDeployedDevicesFleetResponse", + "properties": { + "fleets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesFleet", + "x-maturity": [ + "Preview" + ] + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Fleets/{Sid}" + }, + "get": { + "description": "Fetch information about a specific Key credential in the Fleet.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchDeployedDevicesKey", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesKey", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateDeployedDevicesKey", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Fleets/{Sid}" + }, + "post": { + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesKey", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesKey" + ], + "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "DeviceSid", + "in": "query", + "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListDeployedDevicesKeyResponse", + "properties": { + "keys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListDeployedDevicesKey", + "x-maturity": [ + "Preview" + ] + } + }, + "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + } + }, + "get": { + "description": "Fetch a specific AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchHostedNumbersAuthorizationDocument", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateHostedNumbersAuthorizationDocument", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateHostedNumbersAuthorizationDocumentRequest", + "properties": { + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + }, + "Status": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "ContactPhoneNumber": { + "type": "string", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + } + } + } + } + } + } + } + }, + "/HostedNumbers/AuthorizationDocuments": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" + }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + } + }, + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "parameters": [ + { + "name": "Email", + "in": "query", + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "schema": { + "type": "string" + } + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/authorization_document_enum_status" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListHostedNumbersAuthorizationDocumentResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListHostedNumbersAuthorizationDocument", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateHostedNumbersAuthorizationDocument", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumbersAuthorizationDocumentRequest", + "properties": { + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." + }, + "Email": { + "type": "string", + "description": "Email that this AuthorizationDocument will be sent to for signing." + }, + "ContactTitle": { + "type": "string", + "description": "The title of the person authorized to sign the Authorization Document for this phone number." + }, + "ContactPhoneNumber": { + "type": "string", + "description": "The contact phone number of the person authorized to sign the Authorization Document." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + } + }, + "required": [ + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" + ] + } + } + } + } + } + }, + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/AuthorizationDocuments/{Sid}" + }, + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "tags": [ + "PreviewHostedNumbersDependentHostedNumberOrder" + ], + "parameters": [ + { + "name": "SigningDocumentSid", + "in": "path", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PX[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListHostedNumbersDependentHostedNumberOrderResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListHostedNumbersDependentHostedNumberOrder", + "x-maturity": [ + "Preview" + ] + } + }, + "/HostedNumbers/HostedNumberOrders/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance" + }, + "get": { + "description": "Fetch a specific HostedNumberOrder.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchHostedNumbersHostedNumberOrder", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteHostedNumbersHostedNumberOrder", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Updates a specific HostedNumberOrder.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HR[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateHostedNumbersHostedNumberOrder", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateHostedNumbersHostedNumberOrderRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." + }, + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "Email": { + "type": "string", + "description": "Email of the owner of this phone number that is being hosted." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + }, + "Status": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." + }, + "VerificationCode": { + "type": "string", + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + }, + "Extension": { + "type": "string", + "description": "Digits to dial after connecting the verification call." + }, + "CallDelay": { + "type": "integer", + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." + } + } + } + } + } + } + } + }, + "/HostedNumbers/HostedNumberOrders": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "parameters": [ + { + "name": "Status", + "in": "query", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListHostedNumbersHostedNumberOrderResponse", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListHostedNumbersHostedNumberOrder", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Host a phone number's capability on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersHostedNumberOrder" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateHostedNumbersHostedNumberOrder", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumbersHostedNumberOrderRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." + }, + "UniqueName": { + "type": "string", + "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ] + } + } + } + } + } + }, + "/marketplace/AvailableAddOns/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + } + }, + "get": { + "description": "Fetch an instance of an Add-on currently available to be installed.", + "tags": [ + "PreviewMarketplaceAvailableAddOn" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the AvailableAddOn resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceAvailableAddOn", + "x-maturity": [ + "Preview" + ] + } + }, + "/marketplace/AvailableAddOns": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + } + }, + "get": { + "description": "Retrieve a list of Add-ons currently available to be installed.", + "tags": [ + "PreviewMarketplaceAvailableAddOn" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListMarketplaceAvailableAddOnResponse", + "properties": { + "available_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceAvailableAddOn", + "x-maturity": [ + "Preview" + ] + } + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension" + }, + "get": { + "description": "Fetch an instance of an Extension for the Available Add-on.", + "tags": [ + "PreviewMarketplaceAvailableAddOnExtension" + ], + "parameters": [ + { + "name": "AvailableAddOnSid", + "in": "path", + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceAvailableAddOnExtension", + "x-maturity": [ + "Preview" + ] + } + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension" + }, + "get": { + "description": "Retrieve a list of Extensions for the Available Add-on.", + "tags": [ + "PreviewMarketplaceAvailableAddOnExtension" + ], + "parameters": [ + { + "name": "AvailableAddOnSid", + "in": "path", + "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListMarketplaceAvailableAddOnExtensionResponse", + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceAvailableAddOnExtension", + "x-maturity": [ + "Preview" + ] + } + }, + "/marketplace/InstalledAddOns": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" + } + } + }, + "post": { + "description": "Install an Add-on for the Account specified.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateMarketplaceInstalledAddOn", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateMarketplaceInstalledAddOnRequest", + "properties": { + "AvailableAddOnSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "description": "The SID of the AvaliableAddOn to install." + }, + "AcceptTermsOfService": { + "type": "boolean", + "description": "Whether the Terms of Service were accepted." + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ] + } + } + } + } + }, + "get": { + "description": "Retrieve a list of Add-ons currently installed on this Account.", + "tags": [ + "PreviewMarketplaceInstalledAddOn" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListMarketplaceInstalledAddOnResponse", + "properties": { + "installed_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceInstalledAddOn", + "x-maturity": [ + "Preview" + ] + } }, - "version": "1.52.1" - }, - "openapi": "3.0.1", - "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { + "/marketplace/InstalledAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -1918,46 +6050,43 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" + } + } }, - "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", + "delete": { + "description": "Remove an Add-on installation from your account", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewMarketplaceInstalledAddOn" ], "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "The SID of the InstalledAddOn resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -1965,42 +6094,40 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesCertificate", + "operationId": "DeleteMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ] }, - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "get": { + "description": "Fetch an instance of an Add-on currently installed on this Account.", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewMarketplaceInstalledAddOn" ], "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "The SID of the InstalledAddOn resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + } + } + }, + "description": "OK" } }, "security": [ @@ -2008,35 +6135,26 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesCertificate", + "operationId": "FetchMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.", + "description": "Update an Add-on installation for the Account specified.", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewMarketplaceInstalledAddOn" ], "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", + "description": "The SID of the InstalledAddOn resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CY[0-9a-fA-F]{32}$" + "pattern": "^XE[0-9a-fA-F]{32}$" }, "required": true } @@ -2046,7 +6164,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } } }, @@ -2058,7 +6176,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesCertificate", + "operationId": "UpdateMarketplaceInstalledAddOn", "x-maturity": [ "Preview" ], @@ -2067,18 +6185,14 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesCertificateRequest", + "title": "UpdateMarketplaceInstalledAddOnRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." + "Configuration": { + "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" }, - "DeviceSid": { + "UniqueName": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } } } @@ -2087,7 +6201,7 @@ } } }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -2096,35 +6210,104 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Fleets/{Sid}" + "pathType": "instance", + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension" + }, + "get": { + "description": "Fetch an instance of an Extension for the Installed Add-on.", + "tags": [ + "PreviewMarketplaceInstalledAddOnExtension" + ], + "parameters": [ + { + "name": "InstalledAddOnSid", + "in": "path", + "description": "The SID of the InstalledAddOn resource with the extension to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceInstalledAddOnExtension", + "x-maturity": [ + "Preview" + ] }, "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", + "description": "Update an Extension for an Add-on installation.", "tags": [ - "PreviewDeployedDevicesCertificate" + "PreviewMarketplaceInstalledAddOnExtension" ], "parameters": [ { - "name": "FleetSid", + "name": "InstalledAddOnSid", "in": "path", - "description": "", + "description": "The SID of the InstalledAddOn resource with the extension to update.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the InstalledAddOn Extension resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -2132,7 +6315,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesCertificate", + "operationId": "UpdateMarketplaceInstalledAddOnExtension", "x-maturity": [ "Preview" ], @@ -2141,57 +6324,52 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesCertificateRequest", + "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", "properties": { - "CertificateData": { - "type": "string", - "description": "Provides a URL encoded representation of the public certificate in PEM format." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential." + "Enabled": { + "type": "boolean", + "description": "Whether the Extension should be invoked." } }, "required": [ - "CertificateData" + "Enabled" ] } } } } + } + }, + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension" }, "get": { - "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", + "description": "Retrieve a list of Extensions for the Installed Add-on.", "tags": [ - "PreviewDeployedDevicesCertificate" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, + "PreviewMarketplaceInstalledAddOnExtension" + ], + "parameters": [ { - "name": "DeviceSid", - "in": "query", - "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", + "name": "InstalledAddOnSid", + "in": "path", + "description": "The SID of the InstalledAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } + "pattern": "^XE[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -2227,12 +6405,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesCertificateResponse", + "title": "ListMarketplaceInstalledAddOnExtensionResponse", "properties": { - "certificates": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } }, "meta": { @@ -2279,13 +6457,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesCertificate", + "operationId": "ListMarketplaceInstalledAddOnExtension", "x-maturity": [ "Preview" ] } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -2295,32 +6473,41 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}" }, "get": { - "description": "Fetch information about a specific Deployment in the Fleet.", + "description": "", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewSyncDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -2330,7 +6517,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.sync.service.document" } } }, @@ -2342,35 +6529,35 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesDeployment", + "operationId": "FetchSyncDocument", "x-maturity": [ "Preview" ] }, "delete": { - "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", + "description": "", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewSyncDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -2385,37 +6572,45 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesDeployment", + "operationId": "DeleteSyncDocument", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.", + "description": "", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewSyncDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" + "type": "string" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -2423,7 +6618,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.sync.service.document" } } }, @@ -2435,7 +6630,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesDeployment", + "operationId": "UpdateSyncDocument", "x-maturity": [ "Preview" ], @@ -2444,27 +6639,22 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesDeploymentRequest", + "title": "UpdateSyncDocumentRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long" - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + "Data": { + "description": "" } - } + }, + "required": [ + "Data" + ] } } } } } }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { + "/Sync/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://preview.twilio.com" @@ -2474,20 +6664,32 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}" }, "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", + "description": "", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewSyncDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -2497,7 +6699,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.sync.service.document" } } }, @@ -2509,7 +6711,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesDeployment", + "operationId": "CreateSyncDocument", "x-maturity": [ "Preview" ], @@ -2518,18 +6720,14 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesDeploymentRequest", + "title": "CreateSyncDocumentRequest", "properties": { - "FriendlyName": { + "UniqueName": { "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." + "description": "" }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." + "Data": { + "description": "" } } } @@ -2538,17 +6736,20 @@ } }, "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", + "description": "", "tags": [ - "PreviewDeployedDevicesDeployment" + "PreviewSyncDocument" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -2586,12 +6787,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesDeploymentResponse", + "title": "ListSyncDocumentResponse", "properties": { - "deployments": { + "documents": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" + "$ref": "#/components/schemas/preview.sync.service.document" } }, "meta": { @@ -2638,13 +6839,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesDeployment", + "operationId": "ListSyncDocument", "x-maturity": [ "Preview" ] } }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -2654,27 +6855,40 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Fleets/{Sid}" + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions" }, "get": { - "description": "Fetch information about a specific Device in the Fleet.", + "description": "Fetch a specific Sync Document Permission.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", + "in": "path", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -2686,7 +6900,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } } }, @@ -2698,30 +6912,42 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesDevice", + "operationId": "FetchSyncDocumentPermission", "x-maturity": [ "Preview" ] }, "delete": { - "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", + "description": "Delete a specific Sync Document Permission.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", + "in": "path", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -2738,30 +6964,42 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesDevice", + "operationId": "DeleteSyncDocumentPermission", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.", + "description": "Update an identity's access to a specific Sync Document.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -2773,7 +7011,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } } }, @@ -2785,7 +7023,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesDevice", + "operationId": "UpdateSyncDocumentPermission", "x-maturity": [ "Preview" ], @@ -2794,35 +7032,33 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesDeviceRequest", + "title": "UpdateSyncDocumentPermissionRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Document." }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can update the Sync Document." }, - "Enabled": { + "Manage": { "type": "boolean", - "description": "" + "description": "Boolean flag specifying whether the identity can delete the Sync Document." } - } + }, + "required": [ + "Read", + "Write", + "Manage" + ] } } } } } }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -2832,107 +7068,36 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/Fleets/{Sid}" + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions" }, - "post": { - "description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.", + "get": { + "description": "Retrieve a list of all Permissions applying to a Sync Document.", "tags": [ - "PreviewDeployedDevicesDevice" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDevice", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeviceRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Devices belonging to the Fleet.", - "tags": [ - "PreviewDeployedDevicesDevice" - ], - "parameters": [ + }, { - "name": "FleetSid", + "name": "DocumentSid", "in": "path", - "description": "", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, - { - "name": "DeploymentSid", - "in": "query", - "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$" - } - }, { "name": "PageSize", "in": "query", @@ -2967,12 +7132,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesDeviceResponse", + "title": "ListSyncDocumentPermissionResponse", "properties": { - "devices": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } }, "meta": { @@ -3019,13 +7184,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesDevice", + "operationId": "ListSyncDocumentPermission", "x-maturity": [ "Preview" ] } }, - "/DeployedDevices/Fleets/{Sid}": { + "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -3036,44 +7201,41 @@ "defaultOutputProperties": [], "pathType": "instance", "dependentProperties": { - "devices": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" - }, - "deployments": { + "documents": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + "resource_url": "/Sync/Services/{service_sid}/Documents" }, - "certificates": { + "sync_lists": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + "resource_url": "/Sync/Services/{service_sid}/Lists" }, - "keys": { + "sync_maps": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + "resource_url": "/Sync/Services/{service_sid}/Maps" } } }, "get": { - "description": "Fetch information about a specific Fleet in your account.", + "description": "", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -3083,7 +7245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.sync.service" } } }, @@ -3095,23 +7257,26 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesFleet", + "operationId": "FetchSyncService", "x-maturity": [ "Preview" ] }, "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", + "description": "", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -3126,23 +7291,26 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteDeployedDevicesFleet", + "operationId": "DeleteSyncService", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update the friendly name property of a specific Fleet in your account.", + "description": "", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewSyncService" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -3152,7 +7320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.sync.service" } } }, @@ -3164,7 +7332,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesFleet", + "operationId": "UpdateSyncService", "x-maturity": [ "Preview" ], @@ -3173,18 +7341,24 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateDeployedDevicesFleetRequest", + "title": "UpdateSyncServiceRequest", "properties": { - "FriendlyName": { + "WebhookUrl": { "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + "format": "uri", + "description": "" }, - "DefaultDeploymentSid": { + "FriendlyName": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" } } } @@ -3193,7 +7367,7 @@ } } }, - "/DeployedDevices/Fleets": { + "/Sync/Services": { "servers": [ { "url": "https://preview.twilio.com" @@ -3201,46 +7375,40 @@ ], "description": "TODO: Resource-level docs", "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "devices": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" - }, - "deployments": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "documents": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" + "resource_url": "/Sync/Services/{service_sid}/Documents" }, - "certificates": { + "sync_lists": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + "resource_url": "/Sync/Services/{service_sid}/Lists" }, - "keys": { + "sync_maps": { "mapping": { - "fleet_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" + "resource_url": "/Sync/Services/{service_sid}/Maps" } } }, "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", + "description": "", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewSyncService" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.sync.service" } } }, @@ -3252,7 +7420,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesFleet", + "operationId": "CreateSyncService", "x-maturity": [ "Preview" ], @@ -3261,11 +7429,24 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesFleetRequest", + "title": "CreateSyncServiceRequest", "properties": { "FriendlyName": { "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." + "description": "" + }, + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" } } } @@ -3274,9 +7455,9 @@ } }, "get": { - "description": "Retrieve a list of all Fleets belonging to your account.", + "description": "", "tags": [ - "PreviewDeployedDevicesFleet" + "PreviewSyncService" ], "parameters": [ { @@ -3313,12 +7494,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesFleetResponse", + "title": "ListSyncServiceResponse", "properties": { - "fleets": { + "services": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" + "$ref": "#/components/schemas/preview.sync.service" } }, "meta": { @@ -3365,13 +7546,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesFleet", + "operationId": "ListSyncService", "x-maturity": [ "Preview" ] } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -3381,32 +7562,49 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists" }, "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", + "description": "", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -3416,7 +7614,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } } }, @@ -3428,92 +7626,42 @@ "accountSid_authToken": [] } ], - "operationId": "FetchDeployedDevicesKey", + "operationId": "FetchSyncSyncList", "x-maturity": [ "Preview" ] }, "delete": { - "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", + "description": "", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesKey", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", - "tags": [ - "PreviewDeployedDevicesKey" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KY[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -3521,36 +7669,13 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateDeployedDevicesKey", + "operationId": "DeleteSyncSyncList", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesKeyRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." - } - } - } - } - } - } + ] } }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { + "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" @@ -3560,20 +7685,40 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/Fleets/{Sid}" + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists" }, "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", + "description": "", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "FleetSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -3583,7 +7728,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } } }, @@ -3595,7 +7740,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateDeployedDevicesKey", + "operationId": "CreateSyncSyncList", "x-maturity": [ "Preview" ], @@ -3604,18 +7749,11 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateDeployedDevicesKeyRequest", + "title": "CreateSyncSyncListRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { + "UniqueName": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + "description": "" } } } @@ -3624,30 +7762,22 @@ } }, "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", + "description": "", "tags": [ - "PreviewDeployedDevicesKey" + "PreviewSyncSyncList" ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, + "parameters": [ { - "name": "DeviceSid", - "in": "query", - "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", + "name": "ServiceSid", + "in": "path", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$" - } + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -3683,12 +7813,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListDeployedDevicesKeyResponse", + "title": "ListSyncSyncListResponse", "properties": { - "keys": { + "lists": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } }, "meta": { @@ -3735,13 +7865,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListDeployedDevicesKey", + "operationId": "ListSyncSyncList", "x-maturity": [ "Preview" ] } }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { "servers": [ { "url": "https://preview.twilio.com" @@ -3751,30 +7881,42 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" - }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" - } - } + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items" }, "get": { - "description": "Fetch a specific AuthorizationDocument.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" }, "required": true } @@ -3784,7 +7926,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } }, @@ -3796,28 +7938,114 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersAuthorizationDocument", + "operationId": "FetchSyncSyncListItem", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncListItem", "x-maturity": [ "Preview" ] }, "post": { - "description": "Updates a specific AuthorizationDocument.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -3825,7 +8053,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } }, @@ -3837,7 +8065,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersAuthorizationDocument", + "operationId": "UpdateSyncSyncListItem", "x-maturity": [ "Preview" ], @@ -3846,99 +8074,153 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateHostedNumbersAuthorizationDocumentRequest", + "title": "UpdateSyncSyncListItemRequest", "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." + "Data": { + "description": "" } + }, + "required": [ + "Data" + ] + } + } + } + } + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncSyncListItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } - } - } - } - } - }, - "/HostedNumbers/AuthorizationDocuments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSyncSyncListItem", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncListItemRequest", + "properties": { + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + } + } } } }, "get": { - "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "description": "", "tags": [ - "PreviewHostedNumbersAuthorizationDocument" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "Email", - "in": "query", - "description": "Email that this AuthorizationDocument will be sent to for signing.", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "", "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } + "required": true + }, + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" } }, { - "name": "Status", + "name": "From", "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "description": "", + "schema": { + "type": "string" + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", "schema": { "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status" + "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" } }, { @@ -3975,12 +8257,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersAuthorizationDocumentResponse", + "title": "ListSyncSyncListItemResponse", "properties": { "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } }, "meta": { @@ -4019,34 +8301,191 @@ } } }, - "description": "OK" - } - }, - "security": [ + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncSyncListItem", + "x-maturity": [ + "Preview" + ] + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions" + }, + "get": { + "description": "Fetch a specific Sync List Permission.", + "tags": [ + "PreviewSyncSyncListPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchSyncSyncListPermission", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "Delete a specific Sync List Permission.", + "tags": [ + "PreviewSyncSyncListPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncListPermission", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "Update an identity's access to a specific Sync List.", + "tags": [ + "PreviewSyncSyncListPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, { - "accountSid_authToken": [] + "name": "ListSid", + "in": "path", + "description": "Identifier of the Sync List. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true } ], - "operationId": "ListHostedNumbersAuthorizationDocument", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", - "tags": [ - "PreviewHostedNumbersAuthorizationDocument" - ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4054,7 +8493,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersAuthorizationDocument", + "operationId": "UpdateSyncSyncListPermission", "x-maturity": [ "Preview" ], @@ -4063,48 +8502,25 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersAuthorizationDocumentRequest", + "title": "UpdateSyncSyncListPermissionRequest", "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync List." }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync List." } }, "required": [ - "HostedNumberOrderSids", - "AddressSid", - "Email", - "ContactTitle", - "ContactPhoneNumber" + "Read", + "Write", + "Manage" ] } } @@ -4112,7 +8528,7 @@ } } }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -4122,82 +8538,35 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/AuthorizationDocuments/{Sid}" + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions" }, "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "description": "Retrieve a list of all Permissions applying to a Sync List.", "tags": [ - "PreviewHostedNumbersDependentHostedNumberOrder" + "PreviewSyncSyncListPermission" ], "parameters": [ { - "name": "SigningDocumentSid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "name": "ListSid", + "in": "path", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "required": true }, { "name": "PageSize", @@ -4233,12 +8602,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersDependentHostedNumberOrderResponse", + "title": "ListSyncSyncListPermissionResponse", "properties": { - "items": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } }, "meta": { @@ -4285,13 +8654,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder", + "operationId": "ListSyncSyncListPermission", "x-maturity": [ "Preview" ] } }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4300,23 +8669,50 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance" + "pathType": "instance", + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps" }, "get": { - "description": "Fetch a specific HostedNumberOrder.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true } @@ -4326,7 +8722,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } } }, @@ -4338,26 +8734,35 @@ "accountSid_authToken": [] } ], - "operationId": "FetchHostedNumbersHostedNumberOrder", + "operationId": "FetchSyncSyncMap", "x-maturity": [ "Preview" ] }, "delete": { - "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true } @@ -4372,40 +8777,70 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteHostedNumbersHostedNumberOrder", + "operationId": "DeleteSyncSyncMap", "x-maturity": [ "Preview" ] + } + }, + "/Sync/Services/{ServiceSid}/Maps": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps" }, "post": { - "description": "Updates a specific HostedNumberOrder.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^HR[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -4413,7 +8848,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateHostedNumbersHostedNumberOrder", + "operationId": "CreateSyncSyncMap", "x-maturity": [ "Preview" ], @@ -4422,136 +8857,35 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateHostedNumbersHostedNumberOrderRequest", + "title": "CreateSyncSyncMapRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, "UniqueName": { "type": "string", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "Email": { - "type": "string", - "description": "Email of the owner of this phone number that is being hosted." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status", - "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." - }, - "VerificationCode": { - "type": "string", - "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." - }, - "VerificationType": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." - }, - "VerificationDocumentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." - }, - "Extension": { - "type": "string", - "description": "Digits to dial after connecting the verification call." - }, - "CallDelay": { - "type": "integer", - "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." + "description": "" } } } } } } - } - }, - "/HostedNumbers/HostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" }, "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "Status", - "in": "query", - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status" - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "name": "ServiceSid", + "in": "path", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" + "pattern": "^IS[0-9a-fA-F]{32}$" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "required": true }, { "name": "PageSize", @@ -4587,12 +8921,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListHostedNumbersHostedNumberOrderResponse", + "title": "ListSyncSyncMapResponse", "properties": { - "items": { + "maps": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } }, "meta": { @@ -4631,7 +8965,140 @@ } } }, - "description": "OK" + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListSyncSyncMap", + "x-maturity": [ + "Preview" + ] + } + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items" + }, + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchSyncSyncMapItem", + "x-maturity": [ + "Preview" + ] + }, + "delete": { + "description": "", + "tags": [ + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -4639,26 +9106,66 @@ "accountSid_authToken": [] } ], - "operationId": "ListHostedNumbersHostedNumberOrder", + "operationId": "DeleteSyncSyncMapItem", "x-maturity": [ "Preview" ] }, "post": { - "description": "Host a phone number's capability on Twilio's platform.", + "description": "", "tags": [ - "PreviewHostedNumbersHostedNumberOrder" + "PreviewSyncSyncMapItem" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } + } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -4666,7 +9173,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateHostedNumbersHostedNumberOrder", + "operationId": "UpdateSyncSyncMapItem", "x-maturity": [ "Preview" ], @@ -4675,127 +9182,14 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateHostedNumbersHostedNumberOrderRequest", + "title": "UpdateSyncSyncMapItemRequest", "properties": { - "PhoneNumber": { - "type": "string", - "format": "phone-number", - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" - }, - "SmsCapability": { - "type": "boolean", - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." - }, - "AccountSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." - }, - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." - }, - "SmsUrl": { - "type": "string", - "format": "uri", - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackUrl": { - "type": "string", - "format": "uri", - "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "StatusCallbackUrl": { - "type": "string", - "format": "uri", - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." - }, - "StatusCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." - }, - "SmsApplicationSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." - }, - "Email": { - "type": "string", - "description": "Optional. Email of the owner of this phone number that is being hosted." - }, - "VerificationType": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." - }, - "VerificationDocumentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + "Data": { + "description": "" } }, "required": [ - "PhoneNumber", - "SmsCapability" + "Data" ] } } @@ -4803,7 +9197,7 @@ } } }, - "/marketplace/AvailableAddOns/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -4812,45 +9206,48 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "extensions": { - "mapping": { - "available_add_on_sid": "sid" - }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" - } - } + "pathType": "list", + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items" }, - "get": { - "description": "Fetch an instance of an Add-on currently available to be installed.", + "post": { + "description": "", "tags": [ - "PreviewMarketplaceAvailableAddOn" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "The SID of the AvailableAddOn resource to fetch.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -4858,37 +9255,87 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOn", + "operationId": "CreateSyncSyncMapItem", "x-maturity": [ "Preview" - ] - } - }, - "/marketplace/AvailableAddOns": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "extensions": { - "mapping": { - "available_add_on_sid": "sid" - }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncMapItemRequest", + "properties": { + "Key": { + "type": "string", + "description": "" + }, + "Data": { + "description": "" + } + }, + "required": [ + "Key", + "Data" + ] + } + } } } }, "get": { - "description": "Retrieve a list of Add-ons currently available to be installed.", + "description": "", "tags": [ - "PreviewMarketplaceAvailableAddOn" + "PreviewSyncSyncMapItem" ], "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" + } + }, + { + "name": "From", + "in": "query", + "description": "", + "schema": { + "type": "string" + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" + } + }, { "name": "PageSize", "in": "query", @@ -4923,12 +9370,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceAvailableAddOnResponse", + "title": "ListSyncSyncMapItemResponse", "properties": { - "available_add_ons": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } }, "meta": { @@ -4975,13 +9422,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOn", + "operationId": "ListSyncSyncMapItem", "x-maturity": [ "Preview" ] } }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -4991,36 +9438,42 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions" }, "get": { - "description": "Fetch an instance of an Extension for the Available Add-on.", + "description": "Fetch a specific Sync Map Permission.", "tags": [ - "PreviewMarketplaceAvailableAddOnExtension" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "AvailableAddOnSid", + "name": "ServiceSid", "in": "path", - "description": "The SID of the AvailableAddOn resource with the extension to fetch.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "name": "MapSid", "in": "path", - "description": "The SID of the AvailableAddOn Extension resource to fetch.", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" }, "required": true } @@ -5030,7 +9483,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } } }, @@ -5042,122 +9495,51 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceAvailableAddOnExtension", + "operationId": "FetchSyncSyncMapPermission", "x-maturity": [ "Preview" ] - } - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension" }, - "get": { - "description": "Retrieve a list of Extensions for the Available Add-on.", + "delete": { + "description": "Delete a specific Sync Map Permission.", "tags": [ - "PreviewMarketplaceAvailableAddOnExtension" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "AvailableAddOnSid", + "name": "ServiceSid", "in": "path", - "description": "The SID of the AvailableAddOn resource with the extensions to read.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { - "type": "integer", - "minimum": 0 - } + "type": "string" + }, + "required": true }, { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" - } + }, + "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListMarketplaceAvailableAddOnExtensionResponse", - "properties": { - "extensions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -5165,52 +9547,58 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceAvailableAddOnExtension", + "operationId": "DeleteSyncSyncMapPermission", "x-maturity": [ "Preview" ] - } - }, - "/marketplace/InstalledAddOns": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" + }, + "post": { + "description": "Update an identity's access to a specific Sync Map.", + "tags": [ + "PreviewSyncSyncMapPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + "required": true }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" + "required": true + }, + { + "name": "Identity", + "in": "path", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "schema": { + "type": "string" + }, + "required": true } - } - }, - "post": { - "description": "Install an Add-on for the Account specified.", - "tags": [ - "PreviewMarketplaceInstalledAddOn" ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -5218,7 +9606,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateMarketplaceInstalledAddOn", + "operationId": "UpdateSyncSyncMapPermission", "x-maturity": [ "Preview" ], @@ -5227,42 +9615,72 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateMarketplaceInstalledAddOnRequest", + "title": "UpdateSyncSyncMapPermissionRequest", "properties": { - "AvailableAddOnSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "description": "The SID of the AvaliableAddOn to install." - }, - "AcceptTermsOfService": { + "Read": { "type": "boolean", - "description": "Whether the Terms of Service were accepted." + "description": "Boolean flag specifying whether the identity can read the Sync Map." }, - "Configuration": { - "description": "The JSON object that represents the configuration of the new Add-on being installed." + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Map." } }, "required": [ - "AvailableAddOnSid", - "AcceptTermsOfService" + "Read", + "Write", + "Manage" ] } } } } + } + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions" }, "get": { - "description": "Retrieve a list of Add-ons currently installed on this Account.", + "description": "Retrieve a list of all Permissions applying to a Sync Map.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewSyncSyncMapPermission" ], "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "PageSize", "in": "query", @@ -5297,12 +9715,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceInstalledAddOnResponse", + "title": "ListSyncSyncMapPermissionResponse", "properties": { - "installed_add_ons": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } }, "meta": { @@ -5349,174 +9767,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] - } - }, - "/marketplace/InstalledAddOns/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" - }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" - } - } - }, - "delete": { - "description": "Remove an Add-on installation from your account", - "tags": [ - "PreviewMarketplaceInstalledAddOn" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The SID of the InstalledAddOn resource to delete.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] - }, - "get": { - "description": "Fetch an instance of an Add-on currently installed on this Account.", - "tags": [ - "PreviewMarketplaceInstalledAddOn" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The SID of the InstalledAddOn resource to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchMarketplaceInstalledAddOn", - "x-maturity": [ - "Preview" - ] - }, - "post": { - "description": "Update an Add-on installation for the Account specified.", - "tags": [ - "PreviewMarketplaceInstalledAddOn" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "The SID of the InstalledAddOn resource to update.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateMarketplaceInstalledAddOn", + "operationId": "ListSyncSyncMapPermission", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateMarketplaceInstalledAddOnRequest", - "properties": { - "Configuration": { - "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." - } - } - } - } - } - } + ] } }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { + "/understand/Assistants/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -5526,36 +9783,69 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" + "dependentProperties": { + "field_types": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes" + }, + "tasks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks" + }, + "model_builds": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/ModelBuilds" + }, + "queries": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Queries" + }, + "assistant_fallback_actions": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + }, + "assistant_initiation_actions": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + }, + "dialogues": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Dialogues" + }, + "style_sheet": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + } + } }, "get": { - "description": "Fetch an instance of an Extension for the Installed Add-on.", + "description": "", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewUnderstandAssistant" ], "parameters": [ - { - "name": "InstalledAddOnSid", - "in": "path", - "description": "The SID of the InstalledAddOn resource with the extension to fetch.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -5565,7 +9855,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.understand.assistant" } } }, @@ -5577,38 +9867,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOnExtension", + "operationId": "FetchUnderstandAssistant", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update an Extension for an Add-on installation.", + "description": "", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewUnderstandAssistant" ], "parameters": [ - { - "name": "InstalledAddOnSid", - "in": "path", - "description": "The SID of the InstalledAddOn resource with the extension to update.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to update.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -5618,7 +9893,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.understand.assistant" } } }, @@ -5630,7 +9905,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOnExtension", + "operationId": "UpdateUnderstandAssistant", "x-maturity": [ "Preview" ], @@ -5639,23 +9914,77 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", + "title": "UpdateUnderstandAssistantRequest", "properties": { - "Enabled": { + "FriendlyName": { + "type": "string", + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + }, + "LogQueries": { "type": "boolean", - "description": "Whether the Extension should be invoked." + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "A user-provided URL to send event callbacks to." + }, + "CallbackEvents": { + "type": "string", + "description": "Space-separated list of callback events that will trigger callbacks." + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant" } - }, - "required": [ - "Enabled" - ] + } } } } } + }, + "delete": { + "description": "", + "tags": [ + "PreviewUnderstandAssistant" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteUnderstandAssistant", + "x-maturity": [ + "Preview" + ] } }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { + "/understand/Assistants": { "servers": [ { "url": "https://preview.twilio.com" @@ -5665,27 +9994,63 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension" + "dependentProperties": { + "field_types": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes" + }, + "tasks": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks" + }, + "model_builds": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/ModelBuilds" + }, + "queries": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Queries" + }, + "assistant_fallback_actions": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + }, + "assistant_initiation_actions": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + }, + "dialogues": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Dialogues" + }, + "style_sheet": { + "mapping": { + "assistant_sid": "sid" + }, + "resource_url": "/understandNone" + } + } }, "get": { - "description": "Retrieve a list of Extensions for the Installed Add-on.", + "description": "", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewUnderstandAssistant" ], "parameters": [ - { - "name": "InstalledAddOnSid", - "in": "path", - "description": "The SID of the InstalledAddOn resource with the extensions to read.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" - }, - "required": true - }, { "name": "PageSize", "in": "query", @@ -5720,12 +10085,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceInstalledAddOnExtensionResponse", + "title": "ListUnderstandAssistantResponse", "properties": { - "extensions": { + "assistants": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.understand.assistant" } }, "meta": { @@ -5763,22 +10128,91 @@ } } } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListUnderstandAssistant", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "PreviewUnderstandAssistant" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandAssistant", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandAssistantRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + }, + "LogQueries": { + "type": "boolean", + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "CallbackUrl": { + "type": "string", + "format": "uri", + "description": "A user-provided URL to send event callbacks to." + }, + "CallbackEvents": { + "type": "string", + "description": "Space-separated list of callback events that will trigger callbacks." + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant" + } + } + } + } } - ], - "operationId": "ListMarketplaceInstalledAddOnExtension", - "x-maturity": [ - "Preview" - ] + } } }, - "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "/understand/Assistants/{AssistantSid}/FallbackActions": { "servers": [ { "url": "https://preview.twilio.com" @@ -5788,37 +10222,18 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "dependentProperties": { - "document_permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}" + "parent": "/Assistants/{Sid}", + "mountName": "assistant_fallback_actions", + "className": "assistant_fallback_actions" }, "get": { "description": "", "tags": [ - "PreviewSyncDocument" + "PreviewUnderstandAssistantFallbackActions" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { @@ -5832,7 +10247,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" } } }, @@ -5844,50 +10259,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocument", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "", - "tags": [ - "PreviewSyncDocument" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncDocument", + "operationId": "FetchUnderstandAssistantFallbackActions", "x-maturity": [ "Preview" ] @@ -5895,37 +10267,17 @@ "post": { "description": "", "tags": [ - "PreviewSyncDocument" + "PreviewUnderstandAssistantFallbackActions" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -5933,7 +10285,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" } } }, @@ -5945,7 +10297,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocument", + "operationId": "UpdateUnderstandAssistantFallbackActions", "x-maturity": [ "Preview" ], @@ -5954,22 +10306,19 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentRequest", + "title": "UpdateUnderstandAssistantFallbackActionsRequest", "properties": { - "Data": { + "FallbackActions": { "description": "" } - }, - "required": [ - "Data" - ] + } } } } } } }, - "/Sync/Services/{ServiceSid}/Documents": { + "/understand/Assistants/{AssistantSid}/InitiationActions": { "servers": [ { "url": "https://preview.twilio.com" @@ -5978,47 +10327,37 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "document_permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}" + "pathType": "instance", + "parent": "/Assistants/{Sid}", + "mountName": "assistant_initiation_actions", + "className": "assistant_initiation_actions" }, - "post": { + "get": { "description": "", "tags": [ - "PreviewSyncDocument" + "PreviewUnderstandAssistantInitiationActions" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -6026,74 +10365,25 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncDocument", + "operationId": "FetchUnderstandAssistantInitiationActions", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncDocumentRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - }, - "Data": { - "description": "" - } - } - } - } - } - } + ] }, - "get": { + "post": { "description": "", "tags": [ - "PreviewSyncDocument" + "PreviewUnderstandAssistantInitiationActions" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } } ], "responses": { @@ -6101,48 +10391,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSyncDocumentResponse", - "properties": { - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.sync.service.document" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" } } }, @@ -6154,13 +10403,28 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument", + "operationId": "UpdateUnderstandAssistantInitiationActions", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandAssistantInitiationActionsRequest", + "properties": { + "InitiationActions": { + "description": "" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -6170,40 +10434,27 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "parent": "/Assistants/{Sid}" }, "get": { - "description": "Fetch a specific Sync Document Permission.", + "description": "", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewUnderstandDialogue" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", - "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "", "schema": { "type": "string" }, @@ -6215,7 +10466,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.understand.assistant.dialogue" } } }, @@ -6227,42 +10478,65 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocumentPermission", + "operationId": "FetchUnderstandDialogue", "x-maturity": [ "Preview" ] + } + }, + "/understand/Assistants/{AssistantSid}/Dialogues": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Assistants/{Sid}" + } + }, + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" }, - "delete": { - "description": "Delete a specific Sync Document Permission.", + "get": { + "description": "", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewUnderstandField" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "DocumentSid", + "name": "TaskSid", "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -6270,8 +10544,15 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.field" + } + } + }, + "description": "OK" } }, "security": [ @@ -6279,42 +10560,39 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocumentPermission", + "operationId": "FetchUnderstandField", "x-maturity": [ "Preview" ] }, - "post": { - "description": "Update an identity's access to a specific Sync Document.", + "delete": { + "description": "", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewUnderstandField" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "DocumentSid", + "name": "TaskSid", "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -6322,15 +10600,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -6338,42 +10609,13 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocumentPermission", + "operationId": "DeleteUnderstandField", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncDocumentPermissionRequest", - "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Document." - }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can update the Sync Document." - }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync Document." - } - }, - "required": [ - "Read", - "Write", - "Manage" - ] - } - } - } - } + ] } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { "servers": [ { "url": "https://preview.twilio.com" @@ -6383,31 +10625,27 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "description": "", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewUnderstandField" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "DocumentSid", + "name": "TaskSid", "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, @@ -6447,12 +10685,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncDocumentPermissionResponse", + "title": "ListUnderstandFieldResponse", "properties": { - "permissions": { + "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.understand.assistant.task.field" } }, "meta": { @@ -6499,72 +10737,46 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission", + "operationId": "ListUnderstandField", "x-maturity": [ "Preview" ] - } - }, - "/Sync/Services/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "dependentProperties": { - "documents": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents" - }, - "sync_lists": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists" - }, - "sync_maps": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps" - } - } }, - "get": { + "post": { "description": "", "tags": [ - "PreviewSyncService" + "PreviewUnderstandField" ], "parameters": [ { - "name": "Sid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Field.", + "schema": { + "type": "string" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.understand.assistant.task.field" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -6572,33 +10784,92 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncService", + "operationId": "CreateUnderstandField", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandFieldRequest", + "properties": { + "FieldType": { + "type": "string", + "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type." + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + } + }, + "required": [ + "FieldType", + "UniqueName" + ] + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "dependentProperties": { + "field_values": { + "mapping": { + "assistant_sid": "assistant_sid", + "field_type_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + } + }, + "parent": "/Assistants/{Sid}" }, - "delete": { + "get": { "description": "", "tags": [ - "PreviewSyncService" + "PreviewUnderstandFieldType" ], "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "OK" } }, "security": [ @@ -6606,7 +10877,7 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService", + "operationId": "FetchUnderstandFieldType", "x-maturity": [ "Preview" ] @@ -6614,18 +10885,24 @@ "post": { "description": "", "tags": [ - "PreviewSyncService" + "PreviewUnderstandFieldType" ], "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -6635,7 +10912,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" } } }, @@ -6647,7 +10924,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncService", + "operationId": "UpdateUnderstandFieldType", "x-maturity": [ "Preview" ], @@ -6656,78 +10933,50 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncServiceRequest", + "title": "UpdateUnderstandFieldTypeRequest", "properties": { - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, "FriendlyName": { "type": "string", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." }, - "AclEnabled": { - "type": "boolean", - "description": "" + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." } } } } } } - } - }, - "/Sync/Services": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "dependentProperties": { - "documents": { - "mapping": { - "service_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents" - }, - "sync_lists": { - "mapping": { - "service_sid": "sid" + }, + "delete": { + "description": "", + "tags": [ + "PreviewUnderstandFieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, - "resource_url": "/Sync/Services/{service_sid}/Lists" + "required": true }, - "sync_maps": { - "mapping": { - "service_sid": "sid" + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, - "resource_url": "/Sync/Services/{service_sid}/Maps" + "required": true } - } - }, - "post": { - "description": "", - "tags": [ - "PreviewSyncService" ], "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service" - } - } - }, - "description": "Created" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -6735,46 +10984,48 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncService", + "operationId": "DeleteUnderstandFieldType", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncServiceRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "" - }, - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" - }, - "AclEnabled": { - "type": "boolean", - "description": "" - } - } - } - } - } + ] + } + }, + "/understand/Assistants/{AssistantSid}/FieldTypes": { + "servers": [ + { + "url": "https://preview.twilio.com" } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "field_values": { + "mapping": { + "assistant_sid": "assistant_sid", + "field_type_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + } + }, + "parent": "/Assistants/{Sid}" }, "get": { "description": "", "tags": [ - "PreviewSyncService" + "PreviewUnderstandFieldType" ], "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "PageSize", "in": "query", @@ -6809,12 +11060,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncServiceResponse", + "title": "ListUnderstandFieldTypeResponse", "properties": { - "services": { + "field_types": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.understand.assistant.field_type" } }, "meta": { @@ -6861,13 +11112,74 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService", + "operationId": "ListUnderstandFieldType", "x-maturity": [ "Preview" ] + }, + "post": { + "description": "", + "tags": [ + "PreviewUnderstandFieldType" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.field_type" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandFieldType", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandFieldTypeRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + } + }, + "required": [ + "UniqueName" + ] + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -6877,40 +11189,29 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "dependentProperties": { - "sync_list_items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, - "sync_list_permissions": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" }, "get": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewUnderstandFieldValue" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true }, @@ -6929,7 +11230,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } } }, @@ -6941,7 +11242,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList", + "operationId": "FetchUnderstandFieldValue", "x-maturity": [ "Preview" ] @@ -6949,18 +11250,24 @@ "delete": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewUnderstandFieldValue" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "FieldTypeSid", + "in": "path", + "description": "", + "schema": { + "type": "string" }, "required": true }, @@ -6984,13 +11291,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncList", + "operationId": "DeleteUnderstandFieldValue", "x-maturity": [ "Preview" ] } }, - "/Sync/Services/{ServiceSid}/Lists": { + "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { "servers": [ { "url": "https://preview.twilio.com" @@ -7000,100 +11307,40 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "dependentProperties": { - "sync_list_items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, - "sync_list_permissions": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists" + "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}" }, - "post": { + "get": { "description": "", "tags": [ - "PreviewSyncSyncList" + "PreviewUnderstandFieldValue" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSyncSyncList", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncSyncListRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "", - "tags": [ - "PreviewSyncSyncList" - ], - "parameters": [ + }, { - "name": "ServiceSid", + "name": "FieldTypeSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, + { + "name": "Language", + "in": "query", + "description": "An ISO language-country string of the value. For example: *en-US*", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -7128,12 +11375,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListResponse", + "title": "ListUnderstandFieldValueResponse", "properties": { - "lists": { + "field_values": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } }, "meta": { @@ -7180,45 +11427,19 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList", + "operationId": "ListUnderstandFieldValue", "x-maturity": [ "Preview" ] - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" }, - "get": { + "post": { "description": "", "tags": [ - "PreviewSyncSyncListItem" + "PreviewUnderstandFieldValue" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { @@ -7227,25 +11448,25 @@ "required": true }, { - "name": "Index", + "name": "FieldTypeSid", "in": "path", "description": "", "schema": { - "type": "integer" + "type": "string" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -7253,91 +11474,60 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListItem", + "operationId": "CreateUnderstandFieldValue", "x-maturity": [ "Preview" - ] - }, - "delete": { - "description": "", - "tags": [ - "PreviewSyncSyncListItem" ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Index", - "in": "path", - "description": "", - "schema": { - "type": "integer" - }, - "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandFieldValueRequest", + "properties": { + "Language": { + "type": "string", + "description": "An ISO language-country string of the value." + }, + "Value": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "SynonymOf": { + "type": "string", + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." + } + }, + "required": [ + "Language", + "Value" + ] + } } } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncListItem", - "x-maturity": [ - "Preview" - ] + } + } + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Assistants/{Sid}" }, - "post": { + "get": { "description": "", - "tags": [ - "PreviewSyncSyncListItem" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, + "tags": [ + "PreviewUnderstandModelBuild" + ], + "parameters": [ { - "name": "ListSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { @@ -7346,21 +11536,13 @@ "required": true }, { - "name": "Index", + "name": "Sid", "in": "path", "description": "", "schema": { - "type": "integer" + "type": "string" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -7368,7 +11550,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } }, @@ -7380,63 +11562,28 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListItem", + "operationId": "FetchUnderstandModelBuild", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncSyncListItemRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - } - } - } - } - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items" + ] }, "post": { "description": "", "tags": [ - "PreviewSyncSyncListItem" + "PreviewUnderstandModelBuild" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ListSid", + "name": "Sid", "in": "path", "description": "", "schema": { @@ -7446,15 +11593,15 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -7462,7 +11609,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncListItem", + "operationId": "UpdateUnderstandModelBuild", "x-maturity": [ "Preview" ], @@ -7471,72 +11618,85 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListItemRequest", + "title": "UpdateUnderstandModelBuildRequest", "properties": { - "Data": { - "description": "" + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1" } - }, - "required": [ - "Data" - ] + } } } } } }, - "get": { + "delete": { "description": "", "tags": [ - "PreviewSyncSyncListItem" + "PreviewUnderstandModelBuild" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ListSid", + "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" - } - }, + "accountSid_authToken": [] + } + ], + "operationId": "DeleteUnderstandModelBuild", + "x-maturity": [ + "Preview" + ] + } + }, + "/understand/Assistants/{AssistantSid}/ModelBuilds": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "PreviewUnderstandModelBuild" + ], + "parameters": [ { - "name": "From", - "in": "query", + "name": "AssistantSid", + "in": "path", "description": "", "schema": { "type": "string" - } - }, - { - "name": "Bounds", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" - } + }, + "required": true }, { "name": "PageSize", @@ -7572,12 +11732,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListItemResponse", + "title": "ListUnderstandModelBuildResponse", "properties": { - "items": { + "model_builds": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" } }, "meta": { @@ -7624,56 +11784,21 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListItem", + "operationId": "ListUnderstandModelBuild", "x-maturity": [ "Preview" ] - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" }, - "get": { - "description": "Fetch a specific Sync List Permission.", + "post": { + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewUnderstandModelBuild" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -7681,15 +11806,15 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -7697,51 +11822,80 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncListPermission", + "operationId": "CreateUnderstandModelBuild", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandModelBuildRequest", + "properties": { + "StatusCallback": { + "type": "string", + "format": "uri", + "description": "" + }, + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1" + } + } + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Assistants/{Sid}" }, - "delete": { - "description": "Delete a specific Sync List Permission.", + "get": { + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewUnderstandQuery" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ListSid", + "name": "Sid", "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "description": "OK" } }, "security": [ @@ -7749,42 +11903,30 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncListPermission", + "operationId": "FetchUnderstandQuery", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update an identity's access to a specific Sync List.", + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewUnderstandQuery" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", + "name": "AssistantSid", "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "Sid", "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -7796,7 +11938,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.understand.assistant.query" } } }, @@ -7808,7 +11950,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListPermission", + "operationId": "UpdateUnderstandQuery", "x-maturity": [ "Preview" ], @@ -7817,33 +11959,67 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncListPermissionRequest", + "title": "UpdateUnderstandQueryRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync List." - }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + "SampleSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "description": "An optional reference to the Sample created from this query." }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync List." + "Status": { + "type": "string", + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } } } } } + }, + "delete": { + "description": "", + "tags": [ + "PreviewUnderstandQuery" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteUnderstandQuery", + "x-maturity": [ + "Preview" + ] } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { + "/understand/Assistants/{AssistantSid}/Queries": { "servers": [ { "url": "https://preview.twilio.com" @@ -7853,35 +12029,46 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions" + "parent": "/Assistants/{Sid}" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync List.", + "description": "", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewUnderstandQuery" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ListSid", - "in": "path", - "description": "Identifier of the Sync List. Either a SID or a unique name.", + "name": "Language", + "in": "query", + "description": "An ISO language-country string of the sample.", "schema": { "type": "string" - }, - "required": true + } + }, + { + "name": "ModelBuild", + "in": "query", + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "schema": { + "type": "string" + } + }, + { + "name": "Status", + "in": "query", + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "schema": { + "type": "string" + } }, { "name": "PageSize", @@ -7917,12 +12104,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListPermissionResponse", + "title": "ListUnderstandQueryResponse", "properties": { - "permissions": { + "queries": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.understand.assistant.query" } }, "meta": { @@ -7969,13 +12156,87 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission", + "operationId": "ListUnderstandQuery", "x-maturity": [ "Preview" ] + }, + "post": { + "description": "", + "tags": [ + "PreviewUnderstandQuery" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the parent Assistant.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.query" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandQuery", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandQueryRequest", + "properties": { + "Language": { + "type": "string", + "description": "An ISO language-country string of the sample." + }, + "Query": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long." + }, + "Tasks": { + "type": "string", + "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*" + }, + "ModelBuild": { + "type": "string", + "description": "The Model Build Sid or unique name of the Model Build to be queried." + }, + "Field": { + "type": "string", + "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*" + } + }, + "required": [ + "Language", + "Query" + ] + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7985,49 +12246,100 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "dependentProperties": { - "sync_map_items": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "PreviewUnderstandSample" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + "required": true }, - "sync_map_permissions": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", + "schema": { + "type": "string" }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + } + } + }, + "description": "OK" } }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandSample", + "x-maturity": [ + "Preview" + ] }, - "get": { + "post": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewUnderstandSample" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" + }, + "required": true + }, + { + "name": "TaskSid", + "in": "path", + "description": "The unique ID of the Task associated with this Sample.", + "schema": { + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" }, "required": true } @@ -8037,7 +12349,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } } }, @@ -8049,37 +12361,70 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap", + "operationId": "UpdateUnderstandSample", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUnderstandSampleRequest", + "properties": { + "Language": { + "type": "string", + "description": "An ISO language-country string of the sample." + }, + "TaggedText": { + "type": "string", + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." + }, + "SourceChannel": { + "type": "string", + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" + } + } + } + } + } + } }, "delete": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewUnderstandSample" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "Sid", + "name": "TaskSid", "in": "path", - "description": "", + "description": "The unique ID of the Task associated with this Sample.", "schema": { "type": "string" }, "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -8092,13 +12437,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap", + "operationId": "DeleteUnderstandSample", "x-maturity": [ "Preview" ] } }, - "/Sync/Services/{ServiceSid}/Maps": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { "servers": [ { "url": "https://preview.twilio.com" @@ -8108,100 +12453,40 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "list", - "dependentProperties": { - "sync_map_items": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" - }, - "sync_map_permissions": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}" }, - "post": { + "get": { "description": "", "tags": [ - "PreviewSyncSyncMap" + "PreviewUnderstandSample" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSyncSyncMap", - "x-maturity": [ - "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncSyncMapRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "" - } - } - } - } - } - } - }, - "get": { - "description": "", - "tags": [ - "PreviewSyncSyncMap" - ], - "parameters": [ + }, { - "name": "ServiceSid", + "name": "TaskSid", "in": "path", - "description": "", + "description": "The unique ID of the Task associated with this Sample.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, + { + "name": "Language", + "in": "query", + "description": "An ISO language-country string of the sample.", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -8236,12 +12521,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapResponse", + "title": "ListUnderstandSampleResponse", "properties": { - "maps": { + "samples": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } }, "meta": { @@ -8288,56 +12573,30 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap", + "operationId": "ListUnderstandSample", "x-maturity": [ "Preview" ] - } - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "instance", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" }, - "get": { + "post": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewUnderstandSample" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { "type": "string" }, "required": true }, { - "name": "Key", + "name": "TaskSid", "in": "path", - "description": "", + "description": "The unique ID of the Task associated with this Sample.", "schema": { "type": "string" }, @@ -8345,15 +12604,15 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -8361,59 +12620,78 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem", + "operationId": "CreateUnderstandSample", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandSampleRequest", + "properties": { + "Language": { + "type": "string", + "description": "An ISO language-country string of the sample." + }, + "TaggedText": { + "type": "string", + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." + }, + "SourceChannel": { + "type": "string", + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" + } + }, + "required": [ + "Language", + "TaggedText" + ] + } + } + } + } + } + }, + "/understand/Assistants/{AssistantSid}/StyleSheet": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "instance", + "parent": "/Assistants/{Sid}" }, - "delete": { - "description": "", + "get": { + "description": "Returns Style sheet JSON object for this Assistant", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewUnderstandStyleSheet" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Key", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant", "schema": { "type": "string" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + } + } + }, + "description": "OK" } }, "security": [ @@ -8421,54 +12699,25 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMapItem", + "operationId": "FetchUnderstandStyleSheet", "x-maturity": [ "Preview" ] }, "post": { - "description": "", + "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewUnderstandStyleSheet" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Key", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant", "schema": { "type": "string" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -8476,7 +12725,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" } } }, @@ -8488,7 +12737,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapItem", + "operationId": "UpdateUnderstandStyleSheet", "x-maturity": [ "Preview" ], @@ -8497,22 +12746,19 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapItemRequest", + "title": "UpdateUnderstandStyleSheetRequest", "properties": { - "Data": { - "description": "" + "StyleSheet": { + "description": "The JSON Style sheet string" } - }, - "required": [ - "Data" - ] + } } } } } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -8521,32 +12767,105 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items" + "pathType": "instance", + "dependentProperties": { + "fields": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields" + }, + "samples": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples" + }, + "task_actions": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understandNone" + }, + "statistics": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understandNone" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "PreviewUnderstandTask" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "A 34 character string that uniquely identifies this resource.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchUnderstandTask", + "x-maturity": [ + "Preview" + ] }, "post": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewUnderstandTask" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "MapSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, @@ -8554,15 +12873,15 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.understand.assistant.task" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -8570,7 +12889,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMapItem", + "operationId": "UpdateUnderstandTask", "x-maturity": [ "Preview" ], @@ -8579,77 +12898,127 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncMapItemRequest", + "title": "UpdateUnderstandTaskRequest", "properties": { - "Key": { + "FriendlyName": { "type": "string", - "description": "" + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." }, - "Data": { - "description": "" + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + }, + "ActionsUrl": { + "type": "string", + "format": "uri", + "description": "User-provided HTTP endpoint where from the assistant fetches actions" } - }, - "required": [ - "Key", - "Data" - ] + } } } } } }, - "get": { + "delete": { "description": "", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewUnderstandTask" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "MapSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this resource.", "schema": { "type": "string" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" - } + "accountSid_authToken": [] + } + ], + "operationId": "DeleteUnderstandTask", + "x-maturity": [ + "Preview" + ] + } + }, + "/understand/Assistants/{AssistantSid}/Tasks": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list", + "dependentProperties": { + "fields": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields" }, - { - "name": "From", - "in": "query", - "description": "", - "schema": { - "type": "string" - } + "samples": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples" + }, + "task_actions": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understandNone" }, + "statistics": { + "mapping": { + "assistant_sid": "assistant_sid", + "task_sid": "sid" + }, + "resource_url": "/understandNone" + } + }, + "parent": "/Assistants/{Sid}" + }, + "get": { + "description": "", + "tags": [ + "PreviewUnderstandTask" + ], + "parameters": [ { - "name": "Bounds", - "in": "query", - "description": "", + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" - } + "type": "string" + }, + "required": true }, { "name": "PageSize", @@ -8685,12 +13054,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapItemResponse", + "title": "ListUnderstandTaskResponse", "properties": { - "items": { + "tasks": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.understand.assistant.task" } }, "meta": { @@ -8737,13 +13106,82 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem", + "operationId": "ListUnderstandTask", + "x-maturity": [ + "Preview" + ] + }, + "post": { + "description": "", + "tags": [ + "PreviewUnderstandTask" + ], + "parameters": [ + { + "name": "AssistantSid", + "in": "path", + "description": "The unique ID of the Assistant.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.understand.assistant.task" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateUnderstandTask", "x-maturity": [ "Preview" - ] + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateUnderstandTaskRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + }, + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." + }, + "ActionsUrl": { + "type": "string", + "format": "uri", + "description": "User-provided HTTP endpoint where from the assistant fetches actions" + } + }, + "required": [ + "UniqueName" + ] + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { "servers": [ { "url": "https://preview.twilio.com" @@ -8753,40 +13191,29 @@ "x-twilio": { "defaultOutputProperties": [], "pathType": "instance", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "mountName": "task_actions", + "className": "task_actions" }, "get": { - "description": "Fetch a specific Sync Map Permission.", + "description": "Returns JSON actions for this Task.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewUnderstandTaskActions" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "AssistantSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "TaskSid", "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", + "description": "The unique ID of the Task.", "schema": { "type": "string" }, @@ -8798,7 +13225,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" } } }, @@ -8810,94 +13237,30 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapPermission", - "x-maturity": [ - "Preview" - ] - }, - "delete": { - "description": "Delete a specific Sync Map Permission.", - "tags": [ - "PreviewSyncSyncMapPermission" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncMapPermission", + "operationId": "FetchUnderstandTaskActions", "x-maturity": [ "Preview" ] }, "post": { - "description": "Update an identity's access to a specific Sync Map.", + "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewUnderstandTaskActions" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", + "name": "AssistantSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "The unique ID of the parent Assistant.", "schema": { "type": "string" }, "required": true }, { - "name": "Identity", + "name": "TaskSid", "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", + "description": "The unique ID of the Task.", "schema": { "type": "string" }, @@ -8909,7 +13272,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" } } }, @@ -8921,7 +13284,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapPermission", + "operationId": "UpdateUnderstandTaskActions", "x-maturity": [ "Preview" ], @@ -8930,33 +13293,19 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapPermissionRequest", + "title": "UpdateUnderstandTaskActionsRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Map." - }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." - }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync Map." + "Actions": { + "description": "The JSON actions that instruct the Assistant how to perform this task." } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } } } } } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { + "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { "servers": [ { "url": "https://preview.twilio.com" @@ -8965,63 +13314,33 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [], - "pathType": "list", - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions" + "pathType": "instance", + "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "className": "task_statistics" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "description": "", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewUnderstandTaskStatistics" ], "parameters": [ { - "name": "ServiceSid", + "name": "AssistantSid", "in": "path", - "description": "", + "description": "The unique ID of the parent Assistant.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "MapSid", + "name": "TaskSid", "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", + "description": "The unique ID of the Task associated with this Field.", "schema": { "type": "string" }, "required": true - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } } ], "responses": { @@ -9029,48 +13348,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListSyncSyncMapPermissionResponse", - "properties": { - "permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" } } }, @@ -9082,7 +13360,7 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission", + "operationId": "FetchUnderstandTaskStatistics", "x-maturity": [ "Preview" ] @@ -10200,6 +14478,48 @@ { "name": "PreviewSyncSyncMapPermission" }, + { + "name": "PreviewUnderstandAssistant" + }, + { + "name": "PreviewUnderstandAssistantFallbackActions" + }, + { + "name": "PreviewUnderstandAssistantInitiationActions" + }, + { + "name": "PreviewUnderstandDialogue" + }, + { + "name": "PreviewUnderstandField" + }, + { + "name": "PreviewUnderstandFieldType" + }, + { + "name": "PreviewUnderstandFieldValue" + }, + { + "name": "PreviewUnderstandModelBuild" + }, + { + "name": "PreviewUnderstandQuery" + }, + { + "name": "PreviewUnderstandSample" + }, + { + "name": "PreviewUnderstandStyleSheet" + }, + { + "name": "PreviewUnderstandTask" + }, + { + "name": "PreviewUnderstandTaskActions" + }, + { + "name": "PreviewUnderstandTaskStatistics" + }, { "name": "PreviewWirelessCommand" }, diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index b8a06d55..74407699 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -417,7 +417,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index 35d24bee..33aa7e0c 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -416,7 +416,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index b36af97a..f98500cf 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -39,13 +39,7 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body of message interactions (e.g. `{\"body\": \"hello\"}`) or the call duration (when available) of a call (e.g. `{\"duration\": \"5\"}`).", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -67,7 +61,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-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", @@ -211,13 +205,7 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)" }, "type": { "type": "string", @@ -396,13 +384,7 @@ "identifier": { "type": "string", "nullable": true, - "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -876,7 +858,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -3183,7 +3165,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", - "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) resource that represents the short code you would like to assign to your Proxy Service." + "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service." } }, "required": [ diff --git a/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index b5208bc7..933b7035 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -176,7 +176,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 27ec6087..1dcc822c 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -31,13 +31,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters." }, "date_created": { "type": "string", @@ -103,13 +97,7 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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", @@ -236,8 +224,7 @@ "node10", "node12", "node14", - "node16", - "node18" + "node16" ] }, "serverless.v1.service.build.build_status": { @@ -390,35 +377,17 @@ "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies the Environment resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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 and forms part of the domain name.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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", @@ -476,13 +445,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters." }, "date_created": { "type": "string", @@ -548,13 +511,7 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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", @@ -758,24 +715,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Service resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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. It can be used in place of the Service resource's `sid` in the URL to address the Service resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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", @@ -856,24 +801,12 @@ "key": { "type": "string", "nullable": true, - "description": "A string by which the Variable resource can be referenced.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "description": "A string that contains the actual value of the Variable." }, "date_created": { "type": "string", @@ -916,7 +849,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 466c3862..466ea67b 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -161,23 +161,11 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -231,13 +219,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -305,13 +287,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -362,13 +338,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -512,13 +482,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -569,13 +533,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -630,7 +588,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index 59cf1911..c0730245 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -31,23 +31,11 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -101,13 +89,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -175,13 +157,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -232,13 +208,7 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -518,7 +488,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index bf370646..8fdb4c42 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -89,13 +89,7 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource." }, "sim_sid": { "type": "string", @@ -103,13 +97,13 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls." + "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/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. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each." + "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", @@ -355,13 +349,7 @@ "payload": { "type": "string", "nullable": true, - "description": "The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.\n\nFor an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message \u201cas is\u201d. The payload should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -625,13 +613,7 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM." }, "status": { "type": "string", @@ -743,13 +725,7 @@ "payload": { "type": "string", "nullable": true, - "description": "The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -920,7 +896,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1145,7 +1121,7 @@ { "name": "SimSid", "in": "query", - "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.", + "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.", "schema": { "type": "string" } @@ -2970,12 +2946,6 @@ "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index ef1b7ded..37158209 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -15,13 +15,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -58,13 +52,7 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 7 - } - } + "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", @@ -87,13 +75,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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`." } } }, @@ -127,13 +109,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", @@ -185,13 +161,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 7 - } - } + "description": "The string that you assigned to describe the resource." }, "date_created": { "type": "string", @@ -263,13 +233,7 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 0 - } - } + "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length." } } }, @@ -287,13 +251,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -349,13 +307,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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`." } } }, @@ -404,13 +356,7 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 7 - } - } + "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", @@ -433,13 +379,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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`." } } }, @@ -487,13 +427,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", @@ -532,13 +466,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -594,13 +522,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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`." } } }, @@ -610,13 +532,7 @@ "key": { "type": "string", "nullable": true, - "description": "The unique, user-defined key for the Map Item.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The unique, user-defined key for the Map Item." }, "account_sid": { "type": "string", @@ -655,13 +571,7 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 7 - } - } + "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." }, "date_expires": { "type": "string", @@ -684,13 +594,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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`." } } }, @@ -738,13 +642,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." }, "read": { "type": "boolean", @@ -783,13 +681,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -840,13 +732,7 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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'." } } } @@ -871,7 +757,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1304,12 +1190,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -1366,12 +1246,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -1421,12 +1295,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -2991,12 +2859,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -3053,12 +2915,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -3108,12 +2964,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -3741,12 +3591,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -3803,12 +3647,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -3866,12 +3704,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -4223,12 +4055,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -4285,12 +4111,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -4340,12 +4160,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index 2293cf91..65942ccb 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -197,18 +197,12 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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 [Add-on](https://www.twilio.com/docs/add-ons) data for all installed Add-ons." + "description": "An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) data for all installed addons." }, "date_created": { "type": "string", @@ -436,13 +430,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "max_reserved_workers": { "type": "integer", @@ -510,7 +498,7 @@ "LIFO" ] }, - "taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics": { + "taskrouter.v1.task_queue_bulk_real_time_statistics": { "type": "object", "properties": { "account_sid": { @@ -533,7 +521,7 @@ "type": "array", "items": {}, "nullable": true, - "description": "The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes:\n\n`task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated.\n\n`total_available_workers`: The total number of Workers available for Tasks in the TaskQueue.\n\n`total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state.\n\n`total_tasks`: The total number of Tasks.\n\n`longest_task_waiting_age`: The age of the longest waiting Task.\n\n`longest_task_waiting_sid`: The SID of the longest waiting Task.\n\n`tasks_by_status`: The number of Tasks grouped by their current status.\n\n`tasks_by_priority`: The number of Tasks grouped by priority.\n\n`activity_statistics`: The number of current Workers grouped by Activity.\n" + "description": "The TaskQueue RealTime Statistics for each requested TaskQueue SID, represented as an array of TaskQueue results corresponding to the requested TaskQueue SIDs, each result contains the following attributes: task_queue_sid: The SID of the TaskQueue from which these statistics were calculated, total_available_workers: The total number of Workers available for Tasks in the TaskQueue, total_eligible_workers: The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state, total_tasks: The total number of Tasks, longest_task_waiting_age: The age of the longest waiting Task, longest_task_waiting_sid: The SID of the longest waiting Task, tasks_by_status: The number of Tasks by their current status, tasks_by_priority: The number of Tasks by priority, activity_statistics: The number of current Workers by Activity." }, "task_queue_response_count": { "type": "integer", @@ -990,13 +978,7 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 30 - } - } + "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", @@ -1024,13 +1006,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace." }, "sid": { "type": "string", @@ -1499,13 +1475,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`." }, "sid": { "type": "string", @@ -1820,13 +1790,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`." }, "multi_task_enabled": { "type": "boolean", @@ -2117,7 +2081,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -3171,7 +3135,7 @@ { "name": "HasAddons", "in": "query", - "description": "Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.", + "description": "Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.", "schema": { "type": "boolean" } @@ -4022,12 +3986,6 @@ "description": "The `friendly_name` of the TaskQueue resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -4246,12 +4204,9 @@ "x-twilio": { "defaultOutputProperties": [ "account_sid", - "workspace_sid", - "task_queue_data", - "task_queue_response_count" + "workspace_sid" ], "pathType": "list", - "parent": "/Workspaces/{WorkspaceSid}/TaskQueues", "mountName": "bulk_real_time_statistics", "className": "task_queue_bulk_real_time_statistics" } @@ -5345,10 +5300,6 @@ "BeepOnCustomerEntrance": { "type": "boolean", "description": "Whether to play a notification beep when the customer joins." - }, - "JitterBufferSize": { - "type": "string", - "description": "The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`." } } } @@ -5459,12 +5410,6 @@ "description": "The `friendly_name` of the Worker resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -6908,10 +6853,6 @@ "BeepOnCustomerEntrance": { "type": "boolean", "description": "Whether to play a notification beep when the customer joins." - }, - "JitterBufferSize": { - "type": "string", - "description": "The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`." } } } @@ -7492,12 +7433,6 @@ "description": "The `friendly_name` of the Workflow resources to read.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { @@ -8306,12 +8241,6 @@ "description": "The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index b9afc081..ce59e6e2 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -146,13 +146,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema." }, "friendly_name": { "type": "string", @@ -232,13 +226,7 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the resource." }, "links": { "type": "object", @@ -474,13 +462,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -596,7 +578,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index 769594c7..1eee4dbd 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -27,51 +27,6 @@ } } }, - "trusthub.v1.compliance_tollfree_inquiry": { - "type": "object", - "properties": { - "inquiry_id": { - "type": "string", - "nullable": true, - "description": "The unique ID used to start an embedded compliance registration session." - }, - "inquiry_session_token": { - "type": "string", - "nullable": true, - "description": "The session token used to start an embedded compliance registration session." - }, - "registration_id": { - "type": "string", - "nullable": true, - "description": "The TolfreeId matching the Tollfree Profile that should be resumed or resubmitted for editing." - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true, - "description": "The URL of this resource." - } - } - }, - "compliance_tollfree_inquiry_enum_status": { - "type": "string", - "enum": [ - "PENDING_REVIEW", - "IN_REVIEW", - "TWILIO_APPROVED", - "TWILIO_REJECTED" - ] - }, - "compliance_tollfree_inquiry_enum_opt_in_type": { - "type": "string", - "enum": [ - "VERBAL", - "WEB_FORM", - "PAPER_FORM", - "VIA_TEXT", - "MOBILE_QR_CODE" - ] - }, "trusthub.v1.customer_profile": { "type": "object", "properties": { @@ -370,13 +325,7 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -510,13 +459,7 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -872,7 +815,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1021,160 +964,6 @@ } } }, - "/v1/ComplianceInquiries/Tollfree/Initialize": { - "servers": [ - { - "url": "https://trusthub.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "inquiry_id", - "session_token", - "registration_id" - ], - "pathType": "list", - "mountName": "compliance_tollfree_inquiries", - "className": "compliance_tollfree_inquiries" - }, - "post": { - "description": "Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session.", - "tags": [ - "TrusthubV1ComplianceTollfreeInquiries" - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/trusthub.v1.compliance_tollfree_inquiry" - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateComplianceTollfreeInquiry", - "x-maturity": [ - "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateComplianceTollfreeInquiryRequest", - "properties": { - "TollfreePhoneNumber": { - "type": "string", - "format": "phone-number", - "description": "The Tollfree phone number to be verified" - }, - "NotificationEmail": { - "type": "string", - "description": "The email address to receive the notification about the verification result." - }, - "BusinessName": { - "type": "string", - "description": "The name of the business or organization using the Tollfree number." - }, - "BusinessWebsite": { - "type": "string", - "description": "The website of the business or organization using the Tollfree number." - }, - "UseCaseCategories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The category of the use case for the Tollfree Number. List as many are applicable.." - }, - "UseCaseSummary": { - "type": "string", - "description": "Use this to further explain how messaging is used by the business or organization." - }, - "ProductionMessageSample": { - "type": "string", - "description": "An example of message content, i.e. a sample message." - }, - "OptInImageUrls": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." - }, - "OptInType": { - "type": "string", - "$ref": "#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type", - "description": "Describe how a user opts-in to text messages." - }, - "MessageVolume": { - "type": "string", - "description": "Estimate monthly volume of messages from the Tollfree Number." - }, - "BusinessStreetAddress": { - "type": "string", - "description": "The address of the business or organization using the Tollfree number." - }, - "BusinessStreetAddress2": { - "type": "string", - "description": "The address of the business or organization using the Tollfree number." - }, - "BusinessCity": { - "type": "string", - "description": "The city of the business or organization using the Tollfree number." - }, - "BusinessStateProvinceRegion": { - "type": "string", - "description": "The state/province/region of the business or organization using the Tollfree number." - }, - "BusinessPostalCode": { - "type": "string", - "description": "The postal code of the business or organization using the Tollfree number." - }, - "BusinessCountry": { - "type": "string", - "description": "The country of the business or organization using the Tollfree number." - }, - "AdditionalInformation": { - "type": "string", - "description": "Additional information to be provided for verification." - }, - "BusinessContactFirstName": { - "type": "string", - "description": "The first name of the contact for the business or organization using the Tollfree number." - }, - "BusinessContactLastName": { - "type": "string", - "description": "The last name of the contact for the business or organization using the Tollfree number." - }, - "BusinessContactEmail": { - "type": "string", - "description": "The email address of the contact for the business or organization using the Tollfree number." - }, - "BusinessContactPhone": { - "type": "string", - "format": "phone-number", - "description": "The phone number of the contact for the business or organization using the Tollfree number." - } - }, - "required": [ - "TollfreePhoneNumber", - "NotificationEmail" - ] - } - } - } - } - } - }, "/v1/CustomerProfiles": { "servers": [ { @@ -4917,9 +4706,6 @@ { "name": "TrusthubV1ComplianceInquiries" }, - { - "name": "TrusthubV1ComplianceTollfreeInquiries" - }, { "name": "TrusthubV1CustomerProfiles" }, diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 9e5aded3..8ba68d4b 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -42,13 +42,7 @@ "factor_friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -183,13 +177,7 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -237,33 +225,15 @@ }, "details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be shown to the end user.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "Details provided to give context about the Challenge. Intended to be shown to the end user." }, "hidden_details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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": "Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -330,13 +300,7 @@ "identity": { "type": "string", "nullable": true, - "description": "The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -418,13 +382,7 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -461,13 +419,7 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -628,13 +580,7 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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, @@ -675,13 +621,7 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -759,13 +699,7 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -870,13 +804,7 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number in SafeList.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - } + "description": "The phone number in SafeList." }, "url": { "type": "string", @@ -965,11 +893,6 @@ "pattern": "^HJ[0-9a-fA-F]{32}$", "nullable": true }, - "verify_event_subscription_enabled": { - "type": "boolean", - "nullable": true, - "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" - }, "date_created": { "type": "string", "format": "date-time", @@ -1026,13 +949,7 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1057,24 +974,12 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 1 - } - } + "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. Requires the PSD2 Service flag enabled.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 1 - } - } + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "send_code_attempts": { "type": "array", @@ -1191,7 +1096,7 @@ }, "price": { "nullable": true, - "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing)." + "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/verify/pricing)." }, "channel_data": { "nullable": true, @@ -1328,13 +1233,7 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1355,24 +1254,12 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 1 - } - } + "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. Requires the PSD2 Service flag enabled.", - "x-twilio": { - "pii": { - "handling": "sensitive", - "deleteSla": 1 - } - } + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." }, "date_created": { "type": "string", @@ -1568,7 +1455,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -2247,12 +2134,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -2346,12 +2227,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -2527,12 +2402,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -2595,12 +2464,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -2931,12 +2794,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -2980,12 +2837,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -3054,12 +2905,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -3115,12 +2960,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -3183,12 +3022,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -3318,12 +3151,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -3442,12 +3269,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true } ], @@ -4028,12 +3849,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - }, "required": true }, { @@ -4579,12 +4394,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - }, "required": true } ], @@ -4623,12 +4432,6 @@ "schema": { "type": "string" }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 0 - } - }, "required": true } ], @@ -4816,10 +4619,6 @@ "maxLength": 34, "pattern": "^HJ[0-9a-fA-F]{32}$", "description": "The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only." - }, - "VerifyEventSubscriptionEnabled": { - "type": "boolean", - "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" } }, "required": [ @@ -5185,10 +4984,6 @@ "maxLength": 34, "pattern": "^HJ[0-9a-fA-F]{32}$", "description": "The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only." - }, - "VerifyEventSubscriptionEnabled": { - "type": "boolean", - "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" } } } @@ -5328,10 +5123,6 @@ "type": "string", "$ref": "#/components/schemas/verification_enum_risk_check", "description": "Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: `enable`(default) or `disable`. For SMS channel only." - }, - "Tags": { - "type": "string", - "description": "A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length." } }, "required": [ @@ -5532,12 +5323,6 @@ "description": "Destination of a verification. It is phone number in E.164 format.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 82d5dbce..4034225d 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -58,13 +58,7 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -72,23 +66,11 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -226,13 +208,7 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -240,23 +216,11 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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 in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -446,13 +410,7 @@ "track_name": { "type": "string", "nullable": true, - "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -1360,7 +1318,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index c37981c7..47ff49f4 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -54,13 +54,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call." }, "voice_method": { "type": "string", @@ -80,13 +74,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -106,13 +94,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The URL that we call to pass status parameters (such as call ended) to your application." }, "status_callback_method": { "type": "string", @@ -255,13 +237,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -482,13 +458,7 @@ "ip_address": { "type": "string", "nullable": true, - "description": "An IP address in dotted decimal notation, IPv4 only.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "An IP address in dotted decimal notation, IPv4 only." }, "cidr_prefix_length": { "type": "integer", @@ -583,7 +553,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index b121807c..9636ec63 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -64,13 +64,7 @@ "command": { "type": "string", "nullable": true, - "description": "The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -360,13 +354,7 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "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", @@ -387,24 +375,12 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Sim resource.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The string that you assigned to describe the Sim resource." }, "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM.", - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } - } + "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM." }, "e_id": { "type": "string", @@ -632,7 +608,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.52.1" + "version": "1.53.0" }, "openapi": "3.0.1", "paths": { @@ -1904,12 +1880,6 @@ "description": "Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.", "schema": { "type": "string" - }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 - } } }, { diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index 78ee65ad..3ae3468f 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -16,10 +16,6 @@ components: nullable: true description: The promoted Auth Token that must be used to authenticate future API requests. - x-twilio: - pii: - handling: sensitive - deleteSla: 0 date_created: type: string format: date-time @@ -62,10 +58,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 0 date_created: type: string format: date-time @@ -106,10 +98,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 0 date_created: type: string format: date-time @@ -142,10 +130,6 @@ components: type: string nullable: true description: The phone number in SafeList. - x-twilio: - pii: - handling: standard - deleteSla: 0 accounts.v1.secondary_auth_token: type: object properties: @@ -174,10 +158,6 @@ components: nullable: true description: The generated secondary Auth Token that can be used to authenticate future API requests. - x-twilio: - pii: - handling: sensitive - deleteSla: 0 url: type: string format: uri @@ -198,7 +178,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: @@ -726,10 +706,6 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 0 responses: '200': content: @@ -753,10 +729,6 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 0 responses: '204': description: The resource was deleted successfully. diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 685ce189..77a9e3f4 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -8,10 +8,6 @@ components: nullable: true description: The authorization token for this account. This token should be kept a secret, so no sharing. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -29,10 +25,6 @@ components: nullable: true description: A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address. - x-twilio: - pii: - handling: standard - deleteSla: 30 owner_account_sid: type: string minLength: 34 @@ -101,10 +93,6 @@ components: nullable: true description: The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -121,10 +109,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 iso_country: type: string format: iso-country-code @@ -134,10 +118,6 @@ components: type: string nullable: true description: The postal code of the address. - x-twilio: - pii: - handling: standard - deleteSla: 30 region: type: string nullable: true @@ -154,10 +134,6 @@ components: type: string nullable: true description: The number and street address of the address. - x-twilio: - pii: - handling: standard - deleteSla: 30 uri: type: string nullable: true @@ -185,10 +161,6 @@ components: type: string nullable: true description: The additional number and street address of the address. - x-twilio: - pii: - handling: standard - deleteSla: 30 api.v2010.account.application: type: object properties: @@ -384,6 +356,18 @@ components: pattern: ^CN[0-9a-fA-F]{32}$ nullable: true description: The SID that we assigned to the Connect App. + date_created: + type: string + format: date-time-rfc-2822 + nullable: true + description: The date and time in GMT that the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time-rfc-2822 + nullable: true + description: The date and time in GMT that the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. permissions: type: array items: @@ -1105,10 +1089,6 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. - x-twilio: - pii: - handling: standard - deleteSla: 120 to_formatted: type: string nullable: true @@ -1116,10 +1096,6 @@ components: this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). - x-twilio: - pii: - handling: standard - deleteSla: 120 from: type: string nullable: true @@ -1128,20 +1104,12 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. - x-twilio: - pii: - handling: standard - deleteSla: 120 from_formatted: type: string nullable: true description: The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). - x-twilio: - pii: - handling: standard - deleteSla: 120 phone_number_sid: type: string minLength: 34 @@ -1214,10 +1182,6 @@ components: description: The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. - x-twilio: - pii: - handling: standard - deleteSla: 120 group_sid: type: string minLength: 34 @@ -1231,10 +1195,6 @@ components: nullable: true description: The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. - x-twilio: - pii: - handling: standard - deleteSla: 120 queue_time: type: string nullable: true @@ -1287,18 +1247,10 @@ components: request: nullable: true description: Contains a dictionary representing the request of the call. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 response: nullable: true description: Contains a dictionary representing the call response, including a list of the call events. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 api.v2010.account.call.call_feedback: type: object properties: @@ -2023,18 +1975,10 @@ components: nullable: true description: The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App. - x-twilio: - pii: - handling: standard - deleteSla: 30 company_name: type: string nullable: true description: The company name set for the Connect App. - x-twilio: - pii: - handling: standard - deleteSla: 30 deauthorize_callback_method: type: string format: http-method @@ -2053,36 +1997,20 @@ components: nullable: true description: The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App. - x-twilio: - pii: - handling: standard - deleteSla: 30 description: type: string nullable: true description: The description of the Connect App. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 homepage_url: type: string format: uri nullable: true description: The public URL where users can obtain more information about this Connect App. - x-twilio: - pii: - handling: standard - deleteSla: 30 permissions: type: array items: @@ -2131,10 +2059,6 @@ components: format: phone-number nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 phone_number: type: string format: phone-number @@ -2394,10 +2318,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity_sid: type: string minLength: 34 @@ -2652,10 +2572,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 description: type: string nullable: true @@ -2727,10 +2643,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 product_name: type: string nullable: true @@ -2815,10 +2727,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3108,10 +3016,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3401,10 +3305,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3644,10 +3544,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3750,10 +3646,6 @@ components: type: string nullable: true description: The text content of the message - x-twilio: - pii: - handling: standard - deleteSla: 30 num_segments: type: string nullable: true @@ -3775,28 +3667,19 @@ components: format: phone-number nullable: true description: The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) - format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), + format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), - [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), - or [channel address](https://www.twilio.com/docs/messaging/channels) - (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number - or channel address of the sender. For outgoing messages, this value is - a Twilio phone number, alphanumeric sender ID, short code, or channel - address from which the message is sent. - x-twilio: - pii: - handling: standard - deleteSla: 120 + [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel + address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). + For incoming messages, this is the number or channel address of the sender. + For outgoing messages, this value is a Twilio phone number, alphanumeric + sender ID, short code, or channel address from which the message is sent. to: type: string nullable: true description: The recipient's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`) - x-twilio: - pii: - handling: standard - deleteSla: 120 date_updated: type: string format: date-time-rfc-2822 @@ -3969,7 +3852,7 @@ components: description: 'Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability - with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio).' + with Message Feedback](https://www.twilio.com/docs/sms/send-message-feedback-to-twilio).' date_created: type: string format: date-time-rfc-2822 @@ -4009,10 +3892,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -4047,10 +3926,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -4311,10 +4186,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -4330,10 +4201,6 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. - x-twilio: - pii: - handling: standard - deleteSla: 30 uri: type: string nullable: true @@ -4925,10 +4792,6 @@ components: type: string nullable: true description: The text content of the transcription. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string nullable: true @@ -5086,10 +4949,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 0 sid: type: string minLength: 34 @@ -5125,10 +4984,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 0 sid: type: string minLength: 34 @@ -5167,10 +5022,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 0 sid: type: string minLength: 34 @@ -5208,10 +5059,6 @@ components: type: string nullable: true description: The username for this credential. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -5399,10 +5246,6 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. - x-twilio: - pii: - handling: standard - deleteSla: 30 voice_method: type: string format: http-method @@ -5435,20 +5278,12 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. - x-twilio: - pii: - handling: standard - deleteSla: 30 voice_url: type: string format: uri nullable: true description: The URL we call using the `voice_method` when the domain receives a call. - x-twilio: - pii: - handling: standard - deleteSla: 30 subresource_uris: type: object format: uri-map @@ -5888,10 +5723,6 @@ components: type: string nullable: true description: The text content of the transcription. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string nullable: true @@ -8940,10 +8771,6 @@ components: nullable: true description: The URL we call using the `callback_method` when the trigger fires. - x-twilio: - pii: - handling: sensitive - deleteSla: 60 current_value: type: string nullable: true @@ -9372,10 +9199,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 phone_number: type: string format: phone-number @@ -9383,10 +9206,6 @@ components: description: The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. - x-twilio: - pii: - handling: standard - deleteSla: 30 validation_code: type: string nullable: true @@ -9407,7 +9226,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: @@ -9560,10 +9379,6 @@ paths: match this name. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Status in: query description: Only return Account resources with the given status. Can be `closed`, @@ -9604,58 +9419,26 @@ paths: $ref: '#/components/schemas/api.v2010.account' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -9959,19 +9742,11 @@ paths: description: The `customer_name` of the Address resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: FriendlyName in: query description: The string that identifies the Address resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: IsoCountry in: query description: The ISO country code of the Address resources to read. @@ -10011,58 +9786,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.address' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -10451,58 +10194,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.application' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -10857,58 +10568,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -11011,58 +10690,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -11339,58 +10986,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -11583,58 +11198,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -11827,58 +11410,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -12071,58 +11622,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -12315,58 +11834,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -12559,58 +12046,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -12803,58 +12258,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -13288,10 +12711,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 120 - name: From in: query description: Only include calls from this phone number, SIP address, Client @@ -13299,10 +12718,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 120 - name: ParentCallSid in: query description: Only include calls spawned by calls with this SID. @@ -13411,58 +12826,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.call' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -13791,58 +13174,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.call.call_event' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -14282,58 +13633,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.call.call_notification' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -14533,58 +13852,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.call.call_recording' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -15024,58 +14311,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.conference' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -15354,58 +14609,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -15639,58 +14862,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.connect_app' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -15765,58 +14956,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -16181,10 +15340,6 @@ paths: read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -16231,58 +15386,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -16699,58 +15822,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -16955,58 +16046,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -17050,10 +16109,6 @@ paths: description: A string that identifies the resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -17100,58 +16155,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -17410,10 +16433,6 @@ paths: description: A string that identifies the resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -17460,58 +16479,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -17769,10 +16756,6 @@ paths: description: A string that identifies the resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PhoneNumber in: query description: The phone numbers of the IncomingPhoneNumber resources to read. @@ -17819,58 +16802,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -18279,58 +17230,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.key' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -18583,58 +17502,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.message.media' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -18835,58 +17722,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.queue.member' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -19027,7 +17882,7 @@ paths: location in WhatsApp messages](https://www.twilio.com/docs/whatsapp/message-features#location-messages-with-whatsapp). ShortenUrls: type: boolean - description: 'For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) + description: 'For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/how-to-configure-link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be @@ -19058,16 +17913,17 @@ paths: RiskCheck: type: string $ref: '#/components/schemas/message_enum_risk_check' - description: 'For SMS pumping protection feature only: Include this - parameter with a value of `disable` to skip any kind of risk check - on the respective message request.' + description: 'For SMS pumping protection feature only (public beta + to be available soon): Include this parameter with a value of + `disable` to skip any kind of risk check on the respective message + request.' From: type: string format: phone-number description: The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) - format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), + format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), - [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), + [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the @@ -19103,7 +17959,7 @@ paths: `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types - (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) + (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) @@ -19153,10 +18009,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 120 - name: From in: query description: 'Filter by sender. For example: Set this `from` parameter to @@ -19165,10 +18017,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 120 - name: DateSent in: query description: 'Filter by Message `sent_date`. Accepts GMT dates in the following @@ -19232,58 +18080,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.message' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -19602,58 +18418,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.signing_key' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -19805,58 +18589,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.notification' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -20030,20 +18782,12 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: FriendlyName in: query description: The string that identifies the OutgoingCallerId resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -20077,58 +18821,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -20832,14 +19544,6 @@ paths: description: 'Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.' - CallToken: - type: string - description: A token string needed to invoke a forwarded call. A - call_token is generated when an incoming call is received on a - Twilio number. Pass an incoming call's call_token value to a forwarded - call via the call_token parameter when creating a new call. A - forwarded call should bear the same CallerID of the original incoming - call. required: - From - To @@ -20919,58 +19623,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.conference.participant' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -21423,58 +20095,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.queue' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -21757,58 +20397,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.recording' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -21998,58 +20606,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -22269,58 +20845,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -22499,58 +21043,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -22763,58 +21275,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.short_code' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -23089,58 +21569,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -23367,58 +21815,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -23654,58 +22070,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -23879,58 +22263,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -24211,58 +22563,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -24559,58 +22879,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -24793,58 +23081,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -25272,58 +23528,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -25719,58 +23943,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -25846,58 +24038,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -27820,58 +25980,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.transcription' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -27982,58 +26110,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28135,58 +26231,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28288,58 +26352,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28441,58 +26473,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28594,58 +26594,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28747,58 +26715,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -28900,58 +26836,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -29053,58 +26957,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -29206,58 +27078,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -29579,58 +27419,26 @@ paths: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' end: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "end")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "end")' first_page_uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "firstpageuri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "firstpageuri")' next_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "nextpageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "nextpageuri")' page: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "page")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "page")' page_size: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "pagesize")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "pagesize")' previous_page_uri: type: string format: uri nullable: true - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "previouspageuri") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "previouspageuri")' start: type: integer - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "start")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "start")' uri: type: string format: uri - x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = true, - localName = "uri")' - x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute = - true, localName = "uri")' description: OK security: - accountSid_authToken: [] @@ -29833,48 +27641,6 @@ paths: operationId: DeleteUserDefinedMessageSubscription x-maturity: - GA - /healthcheck: - x-twilio: - className: health_check - libraryVisibility: private - docs_visibility: private - pathType: instance - x-skip-path: 'true' - servers: - - url: https://api.twilio.com - get: - operationId: FetchHealthCheck - description: API HealthCheck - security: [] - tags: - - Api20100401HealthCheck - responses: - '200': - description: OK - content: - application/json: - schema: - x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Healthcheck")' - type: object - properties: - status: - description: HealthCheck status - type: string - x-twilio: - pathType: instance - fixedResponse: - statusCode: 200 - content: - status: ok - transactions: - - name: validateHealthCheck - request: - method: GET - url: https://api.twilio.com/healthcheck.json - response: - statusCode: 200 - content: - status: ok servers: - url: https://api.twilio.com tags: @@ -29903,7 +27669,6 @@ tags: - name: Api20100401Event - name: Api20100401Feedback - name: Api20100401FeedbackSummary -- name: Api20100401HealthCheck - name: Api20100401IncomingPhoneNumber - name: Api20100401IpAccessControlList - name: Api20100401IpAccessControlListMapping diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml new file mode 100644 index 00000000..99a4f5fd --- /dev/null +++ b/spec/yaml/twilio_autopilot_v1.yaml @@ -0,0 +1,3685 @@ +components: + schemas: + autopilot.v1.assistant: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Assistant resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + friendly_name: + type: string + nullable: true + description: The string that you assigned to describe the resource. It is + not unique and can be up to 255 characters long. + latest_model_build_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + nullable: true + description: Reserved. + links: + type: object + format: uri-map + nullable: true + description: A list of the URLs of the Assistant's related resources. + log_queries: + type: boolean + nullable: true + description: 'Whether queries should be logged and kept after training. + Can be: `true` or `false` and defaults to `true`. If `true`, queries are + stored for 30 days, and then deleted. If `false`, no queries are stored.' + development_stage: + type: string + nullable: true + description: A string describing the state of the assistant. + needs_model_build: + type: boolean + nullable: true + description: Whether model needs to be rebuilt. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Assistant + resource. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. It can be up to 64 characters long. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Assistant resource. + callback_url: + type: string + format: uri + nullable: true + description: Reserved. + callback_events: + type: string + nullable: true + description: Reserved. + autopilot.v1.assistant.defaults: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Defaults resource. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Defaults resource. + data: + nullable: true + description: The JSON string that describes the default task links for the + `assistant_initiation`, `collect`, and `fallback` situations. + autopilot.v1.assistant.dialogue: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Dialogue resource. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Dialogue + resource. + data: + nullable: true + description: The JSON string that describes the dialogue session object. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Dialogue resource. + autopilot.v1.assistant.task.field: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Field resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + field_type: + type: string + nullable: true + description: 'The Field Type of the field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), + the unique_name, or the SID of a custom Field Type.' + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + resource associated with this Field. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UE[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Field resource. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Field resource. + autopilot.v1.assistant.field_type: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the FieldType resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + friendly_name: + type: string + nullable: true + description: The string that you assigned to describe the resource. It is + not unique and can be up to 255 characters long. + links: + type: object + format: uri-map + nullable: true + description: A list of the URLs of related resources. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the FieldType + resource. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the FieldType resource. + autopilot.v1.assistant.field_type.field_value: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the FieldValue resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + field_type_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Field Type associated with the Field Value. + language: + type: string + nullable: true + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + tag that specifies the language of the value. Currently supported tags: + `en-US`' + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the FieldType associated with the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the FieldValue + resource. + value: + type: string + nullable: true + description: The Field Value data. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the FieldValue resource. + synonym_of: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ + nullable: true + description: The word for which the field value is a synonym of. + autopilot.v1.assistant.model_build: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the ModelBuild resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the ModelBuild + resource. + status: + type: string + $ref: '#/components/schemas/model_build_enum_status' + nullable: true + description: 'The status of the model build process. Can be: `enqueued`, + `building`, `completed`, or `failed`' + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used as an alternative to the `sid` in the URL path + to address the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the ModelBuild resource. + build_duration: + type: integer + nullable: true + description: The time in seconds it took to build the model. + error_code: + type: integer + nullable: true + description: If the `status` for the model build is `failed`, this value + is a code to more information about the failure. This value will be null + for all other statuses. See [error code dictionary](https://www.twilio.com/docs/api/errors) + for a description of the error. + model_build_enum_status: + type: string + enum: + - enqueued + - building + - completed + - failed + - canceled + autopilot.v1.assistant.query: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Query resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + results: + nullable: true + description: The natural language analysis results that include the [Task](https://www.twilio.com/docs/autopilot/api/task) + recognized and a list of identified [Fields](https://www.twilio.com/docs/autopilot/api/task-field). + language: + type: string + nullable: true + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used by the Query. For example: `en-US`.' + model_build_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) + queried. + query: + type: string + nullable: true + description: The end-user's natural language input. + sample_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + nullable: true + description: The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) + created from the query. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UH[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Query resource. + status: + type: string + nullable: true + description: 'The status of the Query. Can be: `pending-review`, `reviewed`, + or `discarded`' + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Query resource. + source_channel: + type: string + nullable: true + description: The communication channel from where the end-user input came. + dialogue_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + autopilot.v1.restore_assistant: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Assistant resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Assistant + resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. + friendly_name: + type: string + nullable: true + description: The string that you assigned to describe the resource. It is + not unique and can be up to 255 characters long. + needs_model_build: + type: boolean + nullable: true + description: Whether model needs to be rebuilt. + latest_model_build_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + nullable: true + description: Reserved. + log_queries: + type: boolean + nullable: true + description: 'Whether queries should be logged and kept after training. + Can be: `true` or `false` and defaults to `true`. If `true`, queries are + stored for 30 days, and then deleted. If `false`, no queries are stored.' + development_stage: + type: string + nullable: true + description: A string describing the state of the assistant. + callback_url: + type: string + format: uri + nullable: true + description: Reserved. + callback_events: + type: string + nullable: true + description: Reserved. + autopilot.v1.assistant.task.sample: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Sample resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the resource. + language: + type: string + nullable: true + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used for the sample. For example: `en-US`.' + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Sample resource. + tagged_text: + type: string + nullable: true + description: The text example of how end users might express the task. The + sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Sample resource. + source_channel: + type: string + nullable: true + description: 'The communication channel from which the sample was captured. + Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, + or null if not included.' + autopilot.v1.assistant.style_sheet: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the StyleSheet resource. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the StyleSheet resource. + data: + nullable: true + description: The JSON string that describes the style sheet object. + autopilot.v1.assistant.task: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Task resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + friendly_name: + type: string + nullable: true + description: The string that you assigned to describe the resource. It is + not unique and can be up to 255 characters long. + links: + type: object + format: uri-map + nullable: true + description: A list of the URLs of related resources. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Task resource. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. + actions_url: + type: string + format: uri + nullable: true + description: The URL from which the Assistant can fetch actions. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Task resource. + autopilot.v1.assistant.task.task_actions: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskActions resource. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource. + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the TaskActions resource. + data: + nullable: true + description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) + that instruct the Assistant on how to perform the task. + autopilot.v1.assistant.task.task_statistics: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the TaskStatistics resource. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource. + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + for which the statistics were collected. + samples_count: + type: integer + nullable: true + description: The total number of [Samples](https://www.twilio.com/docs/autopilot/api/task-sample) + associated with the Task. + fields_count: + type: integer + nullable: true + description: The total number of [Fields](https://www.twilio.com/docs/autopilot/api/task-field) + associated with the Task. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the TaskStatistics resource. + autopilot.v1.assistant.webhook: + type: object + properties: + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Webhook resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Webhook resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UM[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Webhook resource. + unique_name: + type: string + nullable: true + description: An application-defined string that uniquely identifies the + resource. It can be used in place of the resource's `sid` in the URL to + address the resource. + events: + type: string + nullable: true + description: The list of space-separated events that this Webhook is subscribed + to. + webhook_url: + type: string + format: uri + nullable: true + description: The URL associated with this Webhook. + webhook_method: + type: string + nullable: true + description: The method used when calling the webhook's URL. + securitySchemes: + accountSid_authToken: + type: http + scheme: basic +info: + title: Twilio - Autopilot + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.53.0 +openapi: 3.0.1 +paths: + /v1/Assistants/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: instance + dependentProperties: + field_types: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/FieldTypes + tasks: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks + model_builds: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/ModelBuilds + queries: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Queries + style_sheet: + mapping: + assistant_sid: sid + resource_url: /v1None + defaults: + mapping: + assistant_sid: sid + resource_url: /v1None + dialogues: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Dialogues + webhooks: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Webhooks + get: + description: '' + tags: + - AutopilotV1Assistant + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Assistant + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchAssistant + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Assistant + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Assistant + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateAssistant + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateAssistantRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + resource. It is not unique and can be up to 255 characters long. + LogQueries: + type: boolean + description: 'Whether queries should be logged and kept after training. + Can be: `true` or `false` and defaults to `true`. If `true`, queries + are stored for 30 days, and then deleted. If `false`, no queries + are stored.' + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. It can be used as an alternative to the `sid` in + the URL path to address the resource. The first 64 characters + must be unique. + CallbackUrl: + type: string + format: uri + description: Reserved. + CallbackEvents: + type: string + description: Reserved. + StyleSheet: + description: The JSON string that defines the Assistant's [style + sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) + Defaults: + description: A JSON object that defines the Assistant's [default + tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) + for various scenarios, including initiation actions and fallback + tasks. + DevelopmentStage: + type: string + description: A string describing the state of the assistant. + delete: + description: '' + tags: + - AutopilotV1Assistant + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Assistant + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteAssistant + x-maturity: + - Preview + /v1/Assistants: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: list + dependentProperties: + field_types: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/FieldTypes + tasks: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks + model_builds: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/ModelBuilds + queries: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Queries + style_sheet: + mapping: + assistant_sid: sid + resource_url: /v1None + defaults: + mapping: + assistant_sid: sid + resource_url: /v1None + dialogues: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Dialogues + webhooks: + mapping: + assistant_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Webhooks + get: + description: '' + tags: + - AutopilotV1Assistant + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListAssistantResponse + properties: + assistants: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListAssistant + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Assistant + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateAssistant + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateAssistantRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + new resource. It is not unique and can be up to 255 characters + long. + LogQueries: + type: boolean + description: 'Whether queries should be logged and kept after training. + Can be: `true` or `false` and defaults to `true`. If `true`, queries + are stored for 30 days, and then deleted. If `false`, no queries + are stored.' + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. It can be used as an alternative to the `sid` + in the URL path to address the resource. The first 64 characters + must be unique. + CallbackUrl: + type: string + format: uri + description: Reserved. + CallbackEvents: + type: string + description: Reserved. + StyleSheet: + description: The JSON string that defines the Assistant's [style + sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) + Defaults: + description: A JSON object that defines the Assistant's [default + tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) + for various scenarios, including initiation actions and fallback + tasks. + /v1/Assistants/{AssistantSid}/Defaults: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - data + pathType: instance + parent: /Assistants/{Sid} + className: defaults + get: + description: '' + tags: + - AutopilotV1Defaults + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.defaults' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDefaults + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Defaults + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.defaults' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDefaults + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDefaultsRequest + properties: + Defaults: + description: A JSON string that describes the default task links + for the `assistant_initiation`, `collect`, and `fallback` situations. + /v1/Assistants/{AssistantSid}/Dialogues/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - data + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Dialogue + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Dialogue + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.dialogue' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDialogue + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Dialogues: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - data + pathType: list + parent: /Assistants/{Sid} + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - field_type + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: + description: '' + tags: + - AutopilotV1Field + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource to fetch. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + resource associated with the Field resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Field + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.field' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchField + x-maturity: + - Preview + delete: + description: '' + tags: + - AutopilotV1Field + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resources to delete. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + resource associated with the Field resource to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Field + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteField + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - field_type + pathType: list + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: + description: '' + tags: + - AutopilotV1Field + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resources to read. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + resource associated with the Field resources to read. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListFieldResponse + properties: + fields: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.task.field' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListField + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Field + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the new resource. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + resource associated with the new Field resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.field' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateField + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateFieldRequest + properties: + FieldType: + type: string + description: 'The Field Type of the new field. Can be: a [Built-in + Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), + the `unique_name`, or the `sid` of a custom Field Type.' + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. This value must be a unique string of no more + than 64 characters. It can be used as an alternative to the `sid` + in the URL path to address the resource. + required: + - FieldType + - UniqueName + /v1/Assistants/{AssistantSid}/FieldTypes/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: instance + dependentProperties: + field_values: + mapping: + assistant_sid: assistant_sid + field_type_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1FieldType + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the FieldType + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchFieldType + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1FieldType + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the FieldType + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateFieldType + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateFieldTypeRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + resource. It is not unique and can be up to 255 characters long. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. It can be used as an alternative to the `sid` in + the URL path to address the resource. The first 64 characters + must be unique. + delete: + description: '' + tags: + - AutopilotV1FieldType + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the FieldType + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteFieldType + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/FieldTypes: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: list + dependentProperties: + field_values: + mapping: + assistant_sid: assistant_sid + field_type_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1FieldType + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to read. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListFieldTypeResponse + properties: + field_types: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListFieldType + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1FieldType + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the new resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateFieldType + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateFieldTypeRequest + properties: + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. It can be used as an alternative to the `sid` + in the URL path to address the resource. The first 64 characters + must be unique. + FriendlyName: + type: string + description: A descriptive string that you create to describe the + new resource. It is not unique and can be up to 255 characters + long. + required: + - UniqueName + /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - value + - language + pathType: instance + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + get: + description: '' + tags: + - AutopilotV1FieldValue + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the FieldType associated with the resource to fetch. + schema: + type: string + required: true + - name: FieldTypeSid + in: path + description: The SID of the Field Type associated with the Field Value to + fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the FieldValue + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchFieldValue + x-maturity: + - Preview + delete: + description: '' + tags: + - AutopilotV1FieldValue + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the FieldType associated with the resources to delete. + schema: + type: string + required: true + - name: FieldTypeSid + in: path + description: The SID of the Field Type associated with the Field Value to + delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the FieldValue + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteFieldValue + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - value + - language + pathType: list + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + get: + description: '' + tags: + - AutopilotV1FieldValue + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the FieldType associated with the resources to read. + schema: + type: string + required: true + - name: FieldTypeSid + in: path + description: The SID of the Field Type associated with the Field Value to + read. + schema: + type: string + required: true + - name: Language + in: query + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + tag that specifies the language of the value. Currently supported tags: + `en-US`' + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListFieldValueResponse + properties: + field_values: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListFieldValue + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1FieldValue + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the FieldType associated with the new resource. + schema: + type: string + required: true + - name: FieldTypeSid + in: path + description: The SID of the Field Type associated with the Field Value. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateFieldValue + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateFieldValueRequest + properties: + Language: + type: string + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + tag that specifies the language of the value. Currently supported + tags: `en-US`' + Value: + type: string + description: The Field Value data. + SynonymOf: + type: string + description: The string value that indicates which word the field + value is a synonym of. + required: + - Language + - Value + /v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - status + - date_created + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1ModelBuild + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the ModelBuild + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchModelBuild + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1ModelBuild + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the ModelBuild + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateModelBuild + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateModelBuildRequest + properties: + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be a unique string of no more than + 64 characters. It can be used as an alternative to the `sid` in + the URL path to address the resource. + delete: + description: '' + tags: + - AutopilotV1ModelBuild + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the ModelBuild + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteModelBuild + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/ModelBuilds: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - status + - date_created + pathType: list + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1ModelBuild + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to read. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListModelBuildResponse + properties: + model_builds: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListModelBuild + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1ModelBuild + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the new resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.model_build' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateModelBuild + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateModelBuildRequest + properties: + StatusCallback: + type: string + format: uri + description: The URL we should call using a POST method to send + status information to your application. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. This value must be a unique string of no more + than 64 characters. It can be used as an alternative to the `sid` + in the URL path to address the resource. + /v1/Assistants/{AssistantSid}/Queries/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - query + - status + - language + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Query + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Query + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.query' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchQuery + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Query + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Query + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.query' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateQuery + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateQueryRequest + properties: + SampleSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + description: The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) + created from the query. + Status: + type: string + description: 'The new status of the resource. Can be: `pending-review`, + `reviewed`, or `discarded`' + delete: + description: '' + tags: + - AutopilotV1Query + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Query + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteQuery + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Queries: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - query + - status + - language + pathType: list + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Query + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to read. + schema: + type: string + required: true + - name: Language + in: query + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used by the Query resources to read. + For example: `en-US`.' + schema: + type: string + - name: ModelBuild + in: query + description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) + to be queried. + schema: + type: string + - name: Status + in: query + description: 'The status of the resources to read. Can be: `pending-review`, + `reviewed`, or `discarded`' + schema: + type: string + - name: DialogueSid + in: query + description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListQueryResponse + properties: + queries: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.query' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListQuery + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Query + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the new resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.query' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateQuery + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateQueryRequest + properties: + Language: + type: string + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used for the new query. For + example: `en-US`.' + Query: + type: string + description: The end-user's natural language input. It can be up + to 2048 characters long. + Tasks: + type: string + description: The list of tasks to limit the new query to. Tasks + are expressed as a comma-separated list of task `unique_name` + values. For example, `task-unique_name-1, task-unique_name-2`. + Listing specific tasks is useful to constrain the paths that a + user can take. + ModelBuild: + type: string + description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) + to be queried. + required: + - Language + - Query + /v1/Assistants/Restore: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - account_sid + - sid + - unique_name + - friendly_name + pathType: list + mountName: restore_assistant + post: + description: '' + tags: + - AutopilotV1RestoreAssistant + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.restore_assistant' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateRestoreAssistant + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateRestoreAssistantRequest + properties: + Assistant: + type: string + description: The Twilio-provided string that uniquely identifies + the Assistant resource to restore. + required: + - Assistant + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - tagged_text + - language + - source_channel + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: + description: '' + tags: + - AutopilotV1Sample + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource to fetch. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the Sample resource to create. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Sample + resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchSample + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Sample + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resource to update. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the Sample resource to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Sample + resource to update. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateSample + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSampleRequest + properties: + Language: + type: string + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used for the sample. For example: + `en-US`.' + TaggedText: + type: string + description: The text example of how end users might express the + task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + SourceChannel: + type: string + description: 'The communication channel from which the sample was + captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, + `slack`, or null if not included.' + delete: + description: '' + tags: + - AutopilotV1Sample + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resources to delete. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the Sample resource to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Sample + resource to delete. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSample + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - tagged_text + - language + - source_channel + pathType: list + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: + description: '' + tags: + - AutopilotV1Sample + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the resources to read. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the Sample resources to read. + schema: + type: string + required: true + - name: Language + in: query + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used for the sample. For example: `en-US`.' + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListSampleResponse + properties: + samples: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListSample + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Sample + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task associated with the new resource. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + associated with the Sample resource to create. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSample + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSampleRequest + properties: + Language: + type: string + description: 'The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) + string that specifies the language used for the new sample. For + example: `en-US`.' + TaggedText: + type: string + description: The text example of how end users might express the + task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging). + SourceChannel: + type: string + description: 'The communication channel from which the new sample + was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, + `slack`, or null if not included.' + required: + - Language + - TaggedText + /v1/Assistants/{AssistantSid}/StyleSheet: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - data + pathType: instance + parent: /Assistants/{Sid} + get: + description: Returns Style sheet JSON object for the Assistant + tags: + - AutopilotV1StyleSheet + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchStyleSheet + x-maturity: + - Preview + post: + description: Updates the style sheet for an Assistant identified by `assistant_sid`. + tags: + - AutopilotV1StyleSheet + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateStyleSheet + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateStyleSheetRequest + properties: + StyleSheet: + description: The JSON string that describes the style sheet object. + /v1/Assistants/{AssistantSid}/Tasks/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: instance + dependentProperties: + fields: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields + samples: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples + task_actions: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1None + statistics: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1None + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Task + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Task + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchTask + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Task + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Task + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateTask + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateTaskRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + resource. It is not unique and can be up to 255 characters long. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be 64 characters or less in length + and be unique. It can be used as an alternative to the `sid` in + the URL path to address the resource. + Actions: + description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) + that instruct the Assistant on how to perform the task. + ActionsUrl: + type: string + format: uri + description: The URL from which the Assistant can fetch actions. + delete: + description: '' + tags: + - AutopilotV1Task + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Task + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteTask + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Tasks: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: list + dependentProperties: + fields: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields + samples: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples + task_actions: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1None + statistics: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /v1None + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Task + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to read. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListTaskResponse + properties: + tasks: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.task' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListTask + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Task + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the new resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateTask + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateTaskRequest + properties: + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. It can be used as an alternative to the `sid` + in the URL path to address the resource. This value must be unique + and 64 characters or less in length. + FriendlyName: + type: string + description: A descriptive string that you create to describe the + new resource. It is not unique and can be up to 255 characters + long. + Actions: + description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) + that instruct the Assistant on how to perform the task. It is + optional and not unique. + ActionsUrl: + type: string + format: uri + description: The URL from which the Assistant can fetch actions. + required: + - UniqueName + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - data + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + mountName: task_actions + className: task_actions + get: + description: Returns JSON actions for the Task. + tags: + - AutopilotV1TaskActions + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task for which the task actions to fetch were + defined. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + for which the task actions to fetch were defined. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchTaskActions + x-maturity: + - Preview + post: + description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. + tags: + - AutopilotV1TaskActions + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the Task for which the task actions to update were + defined. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + for which the task actions to update were defined. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateTaskActions + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateTaskActionsRequest + properties: + Actions: + description: The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) + that instruct the Assistant on how to perform the task. + /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - samples_count + - fields_count + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + className: task_statistics + get: + description: '' + tags: + - AutopilotV1TaskStatistics + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) + that is associated with the resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.task.task_statistics' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchTaskStatistics + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Webhooks/{Sid}: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - events + - wehbook_url + - webhook_method + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Webhook + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to fetch. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Webhook + resource to fetch. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchWebhook + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Webhook + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resource to update. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Webhook + resource to update. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateWebhook + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateWebhookRequest + properties: + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. It can be used as an alternative to the `sid` + in the URL path to address the resource. This value must be unique + and 64 characters or less in length. + Events: + type: string + description: The list of space-separated events that this Webhook + will subscribe to. + WebhookUrl: + type: string + format: uri + description: The URL associated with this Webhook. + WebhookMethod: + type: string + description: The method to be used when calling the webhook's URL. + delete: + description: '' + tags: + - AutopilotV1Webhook + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to delete. + schema: + type: string + required: true + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Webhook + resource to delete. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteWebhook + x-maturity: + - Preview + /v1/Assistants/{AssistantSid}/Webhooks: + servers: + - url: https://autopilot.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - events + - wehbook_url + - webhook_method + pathType: list + parent: /Assistants/{Sid} + get: + description: '' + tags: + - AutopilotV1Webhook + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the resources to read. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListWebhookResponse + properties: + webhooks: + type: array + items: + $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListWebhook + x-maturity: + - Preview + post: + description: '' + tags: + - AutopilotV1Webhook + parameters: + - name: AssistantSid + in: path + description: The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) + that is the parent of the new resource. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/autopilot.v1.assistant.webhook' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateWebhook + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateWebhookRequest + properties: + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the new resource. It can be used as an alternative to the `sid` + in the URL path to address the resource. This value must be unique + and 64 characters or less in length. + Events: + type: string + description: The list of space-separated events that this Webhook + will subscribe to. + WebhookUrl: + type: string + format: uri + description: The URL associated with this Webhook. + WebhookMethod: + type: string + description: The method to be used when calling the webhook's URL. + required: + - UniqueName + - Events + - WebhookUrl +servers: +- url: https://autopilot.twilio.com +tags: +- name: AutopilotV1Assistant +- name: AutopilotV1Defaults +- name: AutopilotV1Dialogue +- name: AutopilotV1Field +- name: AutopilotV1FieldType +- name: AutopilotV1FieldValue +- name: AutopilotV1ModelBuild +- name: AutopilotV1Query +- name: AutopilotV1RestoreAssistant +- name: AutopilotV1Sample +- name: AutopilotV1StyleSheet +- name: AutopilotV1Task +- name: AutopilotV1TaskActions +- name: AutopilotV1TaskStatistics +- name: AutopilotV1Webhook +x-maturity: +- name: Preview + description: PLEASE NOTE that this is a Preview product that is subject to change. + Use it with caution. If you currently do not have developer preview access, please + contact https://www.twilio.com/help/contact. diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 9938e9bf..2e2c6740 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -246,7 +246,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Exports/{ResourceType}/Days/{Day}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index f816a260..bd369991 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -30,20 +30,12 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true @@ -51,10 +43,6 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -77,10 +65,6 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 members_count: type: integer nullable: true @@ -130,10 +114,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -210,10 +190,6 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -285,10 +261,6 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -352,10 +324,6 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 service_sid: type: string minLength: 34 @@ -401,18 +369,10 @@ components: nullable: true description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 body: type: string nullable: true description: The content of the message. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 index: type: integer nullable: true @@ -457,10 +417,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -519,10 +475,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -670,18 +622,10 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 role_sid: type: string minLength: 34 @@ -697,10 +641,6 @@ components: resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 is_online: type: boolean nullable: true @@ -831,7 +771,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: @@ -1603,10 +1543,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1929,10 +1865,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index b1a1b2f8..fa2d6edc 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -43,10 +43,6 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity: type: string nullable: true @@ -55,10 +51,6 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 credential_sid: type: string minLength: 34 @@ -128,29 +120,17 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -173,10 +153,6 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 members_count: type: integer nullable: true @@ -303,10 +279,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -383,10 +355,6 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -458,10 +426,6 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -505,10 +469,6 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 member_enum_webhook_enabled_type: type: string enum: @@ -537,10 +497,6 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 service_sid: type: string minLength: 34 @@ -582,10 +538,6 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable. - x-twilio: - pii: - handling: standard - deleteSla: 30 was_edited: type: boolean nullable: true @@ -595,18 +547,10 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 body: type: string nullable: true description: The content of the message. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 index: type: integer nullable: true @@ -624,10 +568,6 @@ components: the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -673,10 +613,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -734,10 +670,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -901,18 +833,10 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 role_sid: type: string minLength: 34 @@ -929,10 +853,6 @@ components: This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 is_online: type: boolean nullable: true @@ -1029,10 +949,6 @@ components: nullable: true description: The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity: type: string nullable: true @@ -1041,10 +957,6 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 user_sid: type: string minLength: 34 @@ -1200,7 +1112,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: @@ -1248,10 +1160,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2587,10 +2495,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2980,10 +2884,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index cb1dd01c..35a76b33 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -30,29 +30,17 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -75,10 +63,6 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 members_count: type: integer nullable: true @@ -125,7 +109,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v3/Services/{ServiceSid}/Channels/{Sid}: diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index 4d4bf676..13c307b4 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -76,7 +76,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) + 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 @@ -136,7 +136,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) + description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource. approval_requests: nullable: true @@ -189,7 +189,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) + description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource. legacy_template_name: type: string @@ -222,7 +222,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Content/{Sid}/ApprovalRequests: diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index b54b8a9a..e6a2fcb0 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -75,10 +75,6 @@ components: nullable: true description: The unique address to be configured. The address can be a whatsapp address or phone number - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true @@ -221,30 +217,18 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 state: type: string $ref: '#/components/schemas/conversation_enum_state' @@ -327,18 +311,10 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 media: type: array items: {} @@ -348,20 +324,12 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 participant_sid: type: string minLength: 34 @@ -402,7 +370,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) + 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 @@ -532,29 +500,17 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. - x-twilio: - pii: - handling: standard - deleteSla: 30 role_sid: type: string minLength: 34 @@ -675,10 +631,6 @@ components: nullable: true description: The human-readable name of this credential, limited to 64 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_type' @@ -752,19 +704,11 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -778,29 +722,17 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 conversation_date_created: type: string format: date-time @@ -869,10 +801,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -931,10 +859,6 @@ components: nullable: true description: The human-readable name of this service, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -1006,10 +930,6 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. - x-twilio: - pii: - handling: standard - deleteSla: 30 identity: type: string nullable: true @@ -1018,10 +938,6 @@ components: within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 binding_type: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' @@ -1140,30 +1056,18 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 state: type: string $ref: '#/components/schemas/service_conversation_enum_state' @@ -1252,18 +1156,10 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 media: type: array items: {} @@ -1273,20 +1169,12 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 participant_sid: type: string minLength: 34 @@ -1327,7 +1215,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) + 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 @@ -1474,29 +1362,17 @@ components: This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. - x-twilio: - pii: - handling: standard - deleteSla: 30 role_sid: type: string minLength: 34 @@ -1681,19 +1557,11 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -1707,29 +1575,17 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 conversation_date_created: type: string format: date-time @@ -1798,10 +1654,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 type: type: string $ref: '#/components/schemas/service_role_enum_role_type' @@ -1877,27 +1729,15 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 is_online: type: boolean nullable: true @@ -1999,10 +1839,6 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/service_user_conversation_enum_state' @@ -2018,10 +1854,6 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 date_created: type: string format: date-time @@ -2050,10 +1882,6 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -2176,27 +2004,15 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 is_online: type: boolean nullable: true @@ -2298,10 +2114,6 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. - x-twilio: - pii: - handling: standard - deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/user_conversation_enum_state' @@ -2317,10 +2129,6 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 date_created: type: string format: date-time @@ -2349,10 +2157,6 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -2390,7 +2194,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Configuration: @@ -3299,7 +3103,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. @@ -5247,10 +5051,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5928,7 +5728,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 7fafda2b..6e4f720c 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -187,7 +187,7 @@ components: schema_version: type: integer nullable: true - description: The schema version that the Subscription should use. + description: The schema version that the subscription should use. subscription_sid: type: string minLength: 34 @@ -267,7 +267,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Types: @@ -351,7 +351,7 @@ paths: - accountSid_authToken: [] operationId: ListEventType x-maturity: - - GA + - Beta /v1/Types/{Type}: servers: - url: https://events.twilio.com @@ -385,7 +385,7 @@ paths: - accountSid_authToken: [] operationId: FetchEventType x-maturity: - - GA + - Beta /v1/Schemas/{Id}: servers: - url: https://events.twilio.com @@ -422,7 +422,7 @@ paths: - accountSid_authToken: [] operationId: FetchSchema x-maturity: - - GA + - Beta /v1/Schemas: servers: - url: https://events.twilio.com @@ -519,7 +519,7 @@ paths: - accountSid_authToken: [] operationId: ListSchemaVersion x-maturity: - - GA + - Beta /v1/Schemas/{Id}/Versions/{SchemaVersion}: servers: - url: https://events.twilio.com @@ -561,7 +561,7 @@ paths: - accountSid_authToken: [] operationId: FetchSchemaVersion x-maturity: - - GA + - Beta /v1/Sinks/{Sid}: servers: - url: https://events.twilio.com @@ -610,7 +610,7 @@ paths: - accountSid_authToken: [] operationId: FetchSink x-maturity: - - GA + - Beta delete: description: Delete a specific Sink. tags: @@ -632,7 +632,7 @@ paths: - accountSid_authToken: [] operationId: DeleteSink x-maturity: - - GA + - Beta post: description: Update a specific Sink tags: @@ -658,7 +658,7 @@ paths: - accountSid_authToken: [] operationId: UpdateSink x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -710,7 +710,7 @@ paths: - accountSid_authToken: [] operationId: CreateSink x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -810,7 +810,7 @@ paths: - accountSid_authToken: [] operationId: ListSink x-maturity: - - GA + - Beta /v1/Sinks/{Sid}/Test: servers: - url: https://events.twilio.com @@ -847,7 +847,7 @@ paths: - accountSid_authToken: [] operationId: CreateSinkTest x-maturity: - - GA + - Beta /v1/Sinks/{Sid}/Validate: servers: - url: https://events.twilio.com @@ -884,7 +884,7 @@ paths: - accountSid_authToken: [] operationId: CreateSinkValidate x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -901,7 +901,7 @@ paths: /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents: servers: - url: https://events.twilio.com - description: Event subscribed to in the parent Subscription + description: Event subscribed to in the parent subscription x-twilio: defaultOutputProperties: - type @@ -983,9 +983,9 @@ paths: - accountSid_authToken: [] operationId: ListSubscribedEvent x-maturity: - - GA + - Beta post: - description: Add an event type to a Subscription. + description: Create a new Subscribed Event type for the subscription tags: - EventsV1SubscribedEvent parameters: @@ -1009,7 +1009,7 @@ paths: - accountSid_authToken: [] operationId: CreateSubscribedEvent x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1022,13 +1022,13 @@ paths: description: Type of event being subscribed to. SchemaVersion: type: integer - description: The schema version that the Subscription should use. + description: The schema version that the subscription should use. required: - Type /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}: servers: - url: https://events.twilio.com - description: Event subscribed to in the parent Subscription + description: Event subscribed to in the parent subscription x-twilio: defaultOutputProperties: - type @@ -1068,7 +1068,7 @@ paths: - accountSid_authToken: [] operationId: FetchSubscribedEvent x-maturity: - - GA + - Beta post: description: Update an Event for a Subscription. tags: @@ -1100,7 +1100,7 @@ paths: - accountSid_authToken: [] operationId: UpdateSubscribedEvent x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1110,9 +1110,9 @@ paths: properties: SchemaVersion: type: integer - description: The schema version that the Subscription should use. + description: The schema version that the subscription should use. delete: - description: Remove an event type from a Subscription. + description: Remove an event type from a subscription. tags: - EventsV1SubscribedEvent parameters: @@ -1138,7 +1138,7 @@ paths: - accountSid_authToken: [] operationId: DeleteSubscribedEvent x-maturity: - - GA + - Beta /v1/Subscriptions: servers: - url: https://events.twilio.com @@ -1230,7 +1230,7 @@ paths: - accountSid_authToken: [] operationId: ListSubscription x-maturity: - - GA + - Beta post: description: Create a new Subscription. tags: @@ -1246,7 +1246,7 @@ paths: - accountSid_authToken: [] operationId: CreateSubscription x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1317,7 +1317,7 @@ paths: - accountSid_authToken: [] operationId: FetchSubscription x-maturity: - - GA + - Beta post: description: Update a Subscription. tags: @@ -1343,7 +1343,7 @@ paths: - accountSid_authToken: [] operationId: UpdateSubscription x-maturity: - - GA + - Beta requestBody: content: application/x-www-form-urlencoded: @@ -1383,7 +1383,7 @@ paths: - accountSid_authToken: [] operationId: DeleteSubscription x-maturity: - - GA + - Beta servers: - url: https://events.twilio.com tags: @@ -1396,5 +1396,6 @@ tags: - name: EventsV1SubscribedEvent - name: EventsV1Subscription x-maturity: -- name: GA - description: This product is Generally Available. +- name: Beta + description: PLEASE NOTE that this is a Beta product that is subject to change. + Use it with caution. diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index e5eaf124..5a158a5b 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -285,9 +285,6 @@ components: citrix_voice_vdi: nullable: true description: Citrix voice vdi configuration and settings. - offline_config: - nullable: true - description: Presence and presence ttl configuration configuration_enum_status: type: string enum: @@ -329,10 +326,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 chat_service_sid: type: string minLength: 34 @@ -883,10 +876,10 @@ components: $ref: '#/components/schemas/interaction_channel_enum_type' nullable: true description: "The Interaction Channel's type. Can be: `sms`, `email`, `chat`,\ - \ `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be\ - \ different from the task channel type specified in the Routing attributes.\ - \ Task channel type corresponds to channel capacity while this channel\ - \ type is the actual media type" + \ `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' @@ -1032,26 +1025,6 @@ components: - external - agent - unknown - flex.v1.provisioning_status: - type: object - properties: - status: - type: string - $ref: '#/components/schemas/provisioning_status_enum_status' - nullable: true - description: Email Provisioning Status - url: - type: string - format: uri - nullable: true - description: The absolute URL of the resource. - provisioning_status_enum_status: - type: string - enum: - - active - - in-progress - - not-configured - - failed flex.v1.web_channel: type: object properties: @@ -1114,7 +1087,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Channels: @@ -1377,10 +1350,6 @@ paths: description: The `friendly_name` of the Flex Flow resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3810,31 +3779,6 @@ paths: must be an agent.' required: - Status - /v1/account/provision/status: - servers: - - url: https://flex-api.twilio.com - description: Status for email provisioning - x-twilio: - defaultOutputProperties: - - status - pathType: instance - mountName: provisioning_status - get: - description: '' - tags: - - FlexV1ProvisioningStatus - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/flex.v1.provisioning_status' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchProvisioningStatus - x-maturity: - - Beta /v1/WebChannels: servers: - url: https://flex-api.twilio.com @@ -4078,14 +4022,10 @@ tags: - name: FlexV1InteractionChannel - name: FlexV1InteractionChannelInvite - name: FlexV1InteractionChannelParticipant -- name: FlexV1ProvisioningStatus - name: FlexV1WebChannel x-maturity: - name: GA description: This product is Generally Available. -- name: Beta - description: PLEASE NOTE that this is a Beta product that is subject to change. - Use it with caution. - name: Preview description: PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index 4f44adc2..7aac3ebf 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -32,7 +32,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/WebChats: diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index 93307570..6dd32489 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -16,18 +16,10 @@ components: description: The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the User. - x-twilio: - pii: - handling: standard - deleteSla: 30 avatar: type: string nullable: true @@ -68,7 +60,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Users/{Sid}: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 67c6081e..e73ac5c4 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -92,6 +92,7 @@ components: type: string format: uri nullable: true + description: The URL of this resource. annotation_enum_answered_by: type: string enum: @@ -210,17 +211,9 @@ components: from: nullable: true description: The calling party. - x-twilio: - pii: - handling: standard - deleteSla: 30 to: nullable: true description: The called party. - x-twilio: - pii: - handling: standard - deleteSla: 30 carrier_edge: nullable: true description: Contains metrics and properties for the Twilio media gateway @@ -335,10 +328,6 @@ components: type: string nullable: true description: Custom label for the conference resource, up to 64 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 create_time: type: string format: date-time @@ -506,10 +495,6 @@ components: type: string nullable: true description: The user-specified label of this participant. - x-twilio: - pii: - handling: standard - deleteSla: 30 conference_sid: type: string minLength: 34 @@ -541,18 +526,10 @@ components: type: string nullable: true description: Caller ID of the calling party. - x-twilio: - pii: - handling: standard - deleteSla: 30 to: type: string nullable: true description: Called party. - x-twilio: - pii: - handling: standard - deleteSla: 30 call_status: type: string $ref: '#/components/schemas/conference_participant_enum_call_status' @@ -908,17 +885,9 @@ components: from: nullable: true description: The calling party. - x-twilio: - pii: - handling: standard - deleteSla: 30 to: nullable: true description: The called party. - x-twilio: - pii: - handling: standard - deleteSla: 30 carrier_edge: nullable: true description: Contains metrics and properties for the Twilio media gateway @@ -1353,7 +1322,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Voice/Settings: @@ -1623,20 +1592,12 @@ paths: Client registered name. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: To in: query description: A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: FromCarrier in: query description: An origination carrier. @@ -1899,10 +1860,6 @@ paths: description: Custom label for the conference resource, up to 64 characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Status in: query description: Conference status. @@ -2107,10 +2064,6 @@ paths: description: User-specified label for a participant. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Events in: query description: Conference events generated by application or participant activity; diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index d7488d03..4ab772dd 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -97,10 +97,6 @@ components: nullable: true description: List of text extraction results. This might be available on classify-extract model outputs. - text_generation_results: - nullable: true - description: Output of a text generation operator for example Conversation - Sumamary. transcript_sid: type: string minLength: 34 @@ -146,10 +142,6 @@ components: type: string nullable: true description: Transcript text. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 sid: type: string minLength: 34 @@ -190,12 +182,9 @@ components: data_logging: type: boolean nullable: true - description: 'Data logging allows Twilio to improve the quality of the speech - recognition & language understanding services through using customer data - to refine, fine tune and evaluate machine learning models. - - Note: Data logging cannot be activated via API, only via www.twilio.com, - as it requires additional consent.' + description: Data logging allows Twilio to improve the quality of the speech + recognition through using customer data to refine its speech recognition + models. date_created: type: string format: date-time @@ -297,12 +286,9 @@ components: data_logging: type: boolean nullable: true - description: 'Data logging allows Twilio to improve the quality of the speech - recognition & language understanding services through using customer data - to refine, fine tune and evaluate machine learning models. - - Note: Data logging cannot be activated via API, only via www.twilio.com, - as it requires additional consent.' + description: Data logging allows Twilio to improve the quality of the speech + recognition through using customer data to refine its speech recognition + models. language_code: type: string nullable: true @@ -364,7 +350,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Transcripts/{Sid}/Media: @@ -692,13 +678,9 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: 'Data logging allows Twilio to improve the quality - of the speech recognition & language understanding services through - using customer data to refine, fine tune and evaluate machine - learning models. - - Note: Data logging cannot be activated via API, only via www.twilio.com, - as it requires additional consent.' + description: Data logging allows Twilio to improve the quality of + the speech recognition through using customer data to refine its + speech recognition models. FriendlyName: type: string description: A human readable description of this resource, up to @@ -885,13 +867,9 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: 'Data logging allows Twilio to improve the quality - of the speech recognition & language understanding services through - using customer data to refine, fine tune and evaluate machine - learning models. - - Note: Data logging cannot be activated via API, only via www.twilio.com, - as it requires additional consent.' + description: Data logging allows Twilio to improve the quality of + the speech recognition through using customer data to refine its + speech recognition models. FriendlyName: type: string description: A human readable description of this resource, up to diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 70b694c4..93d206a2 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -535,7 +535,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 074e7fad..f22a27ce 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -776,7 +776,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 120a1c91..d39de9fa 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -7,19 +7,11 @@ components: nullable: true description: The name of the phone number's owner. If `null`, that information was not available. - x-twilio: - pii: - handling: standard - deleteSla: 30 country_code: type: string nullable: true description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number. - x-twilio: - pii: - handling: standard - deleteSla: 30 phone_number: type: string format: phone-number @@ -27,18 +19,10 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. - x-twilio: - pii: - handling: standard - deleteSla: 30 national_format: type: string nullable: true description: The phone number, in national format. - x-twilio: - pii: - handling: standard - deleteSla: 30 carrier: nullable: true description: The telecom company that provides the phone number. @@ -47,10 +31,6 @@ components: description: A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons). - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -77,7 +57,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: @@ -89,7 +69,6 @@ paths: - caller_name - country_code - carrier - - url pathType: instance get: description: '' @@ -104,10 +83,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: CountryCode in: query @@ -116,10 +91,6 @@ paths: phone number is provided in a national format. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Type in: query description: 'The type of information to return. Can be: `carrier` or `caller-name`. @@ -142,10 +113,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: AddOnsData in: query description: Data specific to the add-on you would like to invoke. The content diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index b1125406..d7a9d2c4 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -12,10 +12,6 @@ components: type: string nullable: true description: The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - x-twilio: - pii: - handling: standard - deleteSla: 30 phone_number: type: string format: phone-number @@ -23,18 +19,10 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. - x-twilio: - pii: - handling: standard - deleteSla: 30 national_format: type: string nullable: true description: The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers). - x-twilio: - pii: - handling: standard - deleteSla: 30 valid: type: boolean nullable: true @@ -52,10 +40,6 @@ components: caller_name: nullable: true description: An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID). - x-twilio: - pii: - handling: standard - deleteSla: 30 sim_swap: nullable: true description: An object that contains information on the last date the subscriber @@ -128,7 +112,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: @@ -155,10 +139,6 @@ paths: country code is +1 (North America). schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Fields in: query @@ -173,10 +153,6 @@ paths: used if the phone number provided is in national format. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: FirstName in: query description: "User\u2019s first name. This query parameter is only used (optionally)\ @@ -233,20 +209,12 @@ paths: \ parameter is only used (optionally) for identity_match package requests." schema: type: string - x-twilio: - pii: - handling: sensitive - deleteSla: 30 - name: DateOfBirth in: query description: "User\u2019s date of birth, in YYYYMMDD format. This query parameter\ \ is only used (optionally) for identity_match package requests." schema: type: string - x-twilio: - pii: - handling: sensitive - deleteSla: 30 - name: LastVerifiedDate in: query description: The date you obtained consent to call or text the end-user of diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index 7eb8b6df..3823aa10 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -36,10 +36,6 @@ components: nullable: true description: 'The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`' - x-twilio: - pii: - handling: standard - deleteSla: 30 extension_context: type: string nullable: true @@ -387,7 +383,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/MediaProcessors: diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index 129c3045..de91bf56 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -341,7 +341,6 @@ components: type: string format: uri nullable: true - description: The absolute URL of the ChannelSender resource. messaging.v1.deactivation: type: object properties: @@ -1067,11 +1066,6 @@ components: nullable: true description: The date and time when the ability to edit a rejected verification expires. - edit_allowed: - type: boolean - nullable: true - description: If a rejected verification is allowed to be edited/resubmitted. - Some rejection reasons allow editing and some do not. resource_links: nullable: true description: The URLs of the documents associated with the Tollfree Verification @@ -1306,7 +1300,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/AlphaSenders: @@ -3549,34 +3543,6 @@ paths: format: phone-number description: The phone number of the contact for the business or organization using the Tollfree number. - EditReason: - type: string - description: Describe why the verification is being edited. If the - verification was rejected because of a technical issue, such as - the website being down, and the issue has been resolved this parameter - should be set to something similar to 'Website fixed'. - delete: - description: '' - tags: - - MessagingV1TollfreeVerification - parameters: - - name: Sid - in: path - description: The unique string to identify Tollfree Verification. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^HH[0-9a-fA-F]{32}$ - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteTollfreeVerification - x-maturity: - - Beta /v1/Tollfree/Verifications: servers: - url: https://messaging.twilio.com diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index f89e7a96..2606bd2e 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -229,7 +229,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Configs: diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index 71794566..4f5f99e5 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -340,7 +340,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Alerts/{Sid}: diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 935f95b5..4a02a65f 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -68,10 +68,6 @@ components: [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service. - x-twilio: - pii: - handling: standard - deleteSla: 120 binding_type: type: string nullable: true @@ -84,10 +80,6 @@ components: FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format. - x-twilio: - pii: - handling: sensitive - deleteSla: 120 tags: type: array items: @@ -96,10 +88,6 @@ components: description: The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed. - x-twilio: - pii: - handling: standard - deleteSla: 120 url: type: string format: uri @@ -216,10 +204,6 @@ components: description: The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list. - x-twilio: - pii: - handling: standard - deleteSla: 120 tags: type: array items: @@ -228,10 +212,6 @@ components: description: The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property. - x-twilio: - pii: - handling: standard - deleteSla: 120 segments: type: array items: @@ -274,10 +254,6 @@ components: For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. - x-twilio: - pii: - handling: standard - deleteSla: 0 sound: type: string nullable: true @@ -413,7 +389,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) + 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: @@ -486,7 +462,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Bindings/{Sid}: @@ -705,10 +681,6 @@ paths: type: array items: type: string - x-twilio: - pii: - handling: standard - deleteSla: 120 - name: Tag in: query description: 'Only list Bindings that have all of the specified Tags. The @@ -1154,12 +1126,12 @@ paths: description: 'The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the - Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These - parameters of the Message resource are supported in snake case - format: `body`, `media_urls`, `status_callback`, and `max_price`. The - `status_callback` parameter overrides the corresponding parameter - in the messaging service, if configured. The `media_urls` property - expects a JSON array.' + Twilio [Message](https://www.twilio.com/docs/sms/send-messages) + resource. These parameters of the Message resource are supported + in snake case format: `body`, `media_urls`, `status_callback`, + and `max_price`. The `status_callback` parameter overrides the + corresponding parameter in the messaging service, if configured. + The `media_urls` property expects a JSON array.' FacebookMessenger: description: Deprecated. Fcm: @@ -1287,7 +1259,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: @@ -1539,7 +1511,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index 982e8466..98e01f43 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -160,74 +160,11 @@ components: maxLength: 34 pattern: ^KW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Port In request. This is a unique identifier - of the port in request. + description: The SID of the Port In request, It is the request identifier url: type: string format: uri nullable: true - numbers.v1.porting_port_in_fetch: - type: object - properties: - port_in_request_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KW[0-9a-fA-F]{32}$ - nullable: true - description: The SID of the Port In request. This is a unique identifier - of the port in request. - url: - type: string - format: uri - nullable: true - description: The URL of this Port In request - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The Account SID that the numbers will be added to after they - are ported into Twilio. - notification_emails: - type: array - items: - type: string - nullable: true - description: List of emails for getting notifications about the LOA signing - process. Allowed Max 10 emails. - target_port_in_date: - type: string - format: date - nullable: true - description: Minimum number of days in the future (at least 2 days) needs - to be established with the Ops team for validation. - target_port_in_time_range_start: - type: string - nullable: true - description: Minimum hour in the future needs to be established with the - Ops team for validation. - target_port_in_time_range_end: - type: string - nullable: true - description: Maximum hour in the future needs to be established with the - Ops team for validation. - losing_carrier_information: - nullable: true - description: 'The information for the losing carrier. ' - phone_numbers: - type: array - items: {} - nullable: true - description: The list of phone numbers to Port in. Phone numbers are in - E.164 format (e.g. +16175551212). - documents: - type: array - items: - type: string - nullable: true - description: The list of documents SID referencing a utility bills numbers.v1.porting_portability: type: object properties: @@ -311,7 +248,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/HostedNumber/Eligibility/Bulk: @@ -455,43 +392,6 @@ paths: - port_in_request_sid pathType: list mountName: porting_port_ins - /v1/Porting/PortIn/{PortInRequestSid}: - servers: - - url: https://numbers.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - port_in_request_sid - pathType: instance - mountName: porting_port_ins - className: porting_port_in_fetch - get: - description: Fetch a port in request by SID - tags: - - NumbersV1PortingPortInFetch - parameters: - - name: PortInRequestSid - in: path - description: The SID of the Port In request. This is a unique identifier of - the port in request. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^KW[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/numbers.v1.porting_port_in_fetch' - description: OK - security: - - accountSid_authToken: [] - operationId: FetchPortingPortInFetch - x-maturity: - - Beta /v1/Porting/Portability/PhoneNumber/{PhoneNumber}: servers: - url: https://numbers.twilio.com @@ -539,7 +439,6 @@ servers: tags: - name: NumbersV1BulkEligibility - name: NumbersV1PortingBulkPortability -- name: NumbersV1PortingPortInFetch - name: NumbersV1PortingPortability x-maturity: - name: Beta diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index 285aae71..e22f2122 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -30,10 +30,6 @@ components: type: string nullable: true description: Email that this AuthorizationDocument will be sent to for signing. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -41,10 +37,6 @@ components: nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -94,19 +86,11 @@ components: nullable: true description: A 128 character string that is a human-readable text that describes this resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 notification_email: type: string nullable: true description: Email address used for send notifications about this Bulk hosted number request. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -135,10 +119,6 @@ components: description: Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'. - x-twilio: - pii: - handling: standard - deleteSla: 30 bulk_hosted_number_order_enum_request_status: type: string enum: @@ -398,10 +378,6 @@ components: type: string nullable: true description: A human readable description of this resource, up to 128 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' @@ -431,10 +407,6 @@ components: type: string nullable: true description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -442,10 +414,6 @@ components: nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed - x-twilio: - pii: - handling: standard - deleteSla: 30 contact_title: type: string nullable: true @@ -500,10 +468,6 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -664,10 +628,6 @@ components: nullable: true description: Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212 - x-twilio: - pii: - handling: standard - deleteSla: 30 capabilities: type: object format: phone-number-capabilities @@ -688,10 +648,6 @@ components: nullable: true description: A 128 character string that is a human-readable text that describes this resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/hosted_number_order_enum_status' @@ -722,10 +678,6 @@ components: type: string nullable: true description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -733,10 +685,6 @@ components: nullable: true description: A list of emails that LOA document for this HostedNumberOrder will be carbon copied to. - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -992,10 +940,6 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -1070,7 +1014,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/HostedNumber/AuthorizationDocuments/{Sid}: @@ -1156,10 +1100,6 @@ paths: description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Status in: query description: 'Status of an instance resource. It can hold one of the values: @@ -1869,10 +1809,6 @@ paths: description: A human readable description of this resource, up to 128 characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2497,10 +2433,6 @@ paths: schema: type: string format: phone-number - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: IncomingPhoneNumberSid in: query description: A 34 character string that uniquely identifies the IncomingPhoneNumber @@ -2515,10 +2447,6 @@ paths: description: A human readable description of this resource, up to 128 characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is diff --git a/spec/yaml/twilio_oauth_v1.yaml b/spec/yaml/twilio_oauth_v1.yaml new file mode 100644 index 00000000..f1e057fc --- /dev/null +++ b/spec/yaml/twilio_oauth_v1.yaml @@ -0,0 +1,422 @@ +components: + schemas: + oauth.v1.certs: + type: object + properties: + keys: + nullable: true + description: A collection of certificates where are signed Twilio-issued + tokens. + url: + type: string + format: uri + nullable: true + oauth.v1.device_code: + type: object + properties: + device_code: + type: string + nullable: true + description: The device verification code. + user_code: + type: string + nullable: true + description: The verification code which end user uses to verify authorization + request. + verification_uri: + type: string + nullable: true + description: The URI that the end user visits to verify authorization request. + verification_uri_complete: + type: string + nullable: true + description: The URI with user_code that the end-user alternatively visits + to verify authorization request. + expires_in: + type: integer + format: int64 + nullable: true + description: The expiration time of the device_code and user_code in seconds. + interval: + type: integer + nullable: true + description: The minimum amount of time in seconds that the client should + wait between polling requests to the token endpoint. + oauth.v1.openid_discovery: + type: object + properties: + issuer: + type: string + format: uri + nullable: true + description: The URL of the party that will create the token and sign it + with its private key. + authorization_endpoint: + type: string + format: uri + nullable: true + description: The endpoint that validates all authorization requests. + device_authorization_endpoint: + type: string + format: uri + nullable: true + description: The endpoint that validates all device code related authorization + requests. + token_endpoint: + type: string + format: uri + nullable: true + description: The URL of the token endpoint. After a client has received + an authorization code, that code is presented to the token endpoint and + exchanged for an identity token, an access token, and a refresh token. + userinfo_endpoint: + type: string + format: uri + nullable: true + description: The URL of the user info endpoint, which returns user profile + information to a client. Keep in mind that the user info endpoint returns + only the information that has been requested. + revocation_endpoint: + type: string + format: uri + nullable: true + description: The endpoint used to revoke access or refresh tokens issued + by the authorization server. + jwk_uri: + type: string + format: uri + nullable: true + description: The URL of your JSON Web Key Set. This set is a collection + of JSON Web Keys, a standard method for representing cryptographic keys + in a JSON structure. + response_type_supported: + type: array + items: + type: string + nullable: true + description: A collection of response type supported by authorization server. + subject_type_supported: + type: array + items: + type: string + nullable: true + description: A collection of subject by authorization server. + id_token_signing_alg_values_supported: + type: array + items: + type: string + nullable: true + description: A collection of JWS signing algorithms supported by authorization + server to sign identity token. + scopes_supported: + type: array + items: + type: string + nullable: true + description: A collection of scopes supported by authorization server for + identity token + claims_supported: + type: array + items: + type: string + nullable: true + description: A collection of claims supported by authorization server for + identity token + url: + type: string + format: uri + nullable: true + oauth.v1.token: + type: object + properties: + access_token: + type: string + nullable: true + description: Token which carries the necessary information to access a Twilio + resource directly. + refresh_token: + type: string + nullable: true + description: Token which carries the information necessary to get a new + access token. + id_token: + type: string + nullable: true + refresh_token_expires_at: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the refresh token expires in + [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + access_token_expires_at: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the refresh token expires in + [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + oauth.v1.user_info: + type: object + properties: + user_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^US[0-9a-fA-F]{32}$ + nullable: true + description: The URL of the party that will create the token and sign it + with its private key. + first_name: + type: string + nullable: true + description: The first name of the end-user. + last_name: + type: string + nullable: true + description: The last name of the end-user. + friendly_name: + type: string + nullable: true + description: The friendly name of the end-user. + email: + type: string + nullable: true + description: The end-user's preferred email address. + url: + type: string + format: uri + nullable: true + securitySchemes: + accountSid_authToken: + type: http + scheme: basic +info: + title: Twilio - Oauth + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.53.0 +openapi: 3.0.1 +paths: + /v1/certs: + servers: + - url: https://oauth.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - keys + pathType: instance + mountName: oauth + get: + description: Fetches public JWKs + tags: + - OauthV1Oauth + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/oauth.v1.certs' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchCerts + x-maturity: + - GA + /v1/device/code: + servers: + - url: https://oauth.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - device_code + - user_code + - verification_uri + - verification_uri_complete + - expires_in + - interval + pathType: list + mountName: device_code + post: + description: Issues a new Access token (optionally identity_token & refresh_token) + in exchange of Oauth grant + tags: + - OauthV1DeviceCode + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/oauth.v1.device_code' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeviceCode + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeviceCodeRequest + properties: + ClientSid: + type: string + description: A 34 character string that uniquely identifies this + OAuth App. + Scopes: + type: array + items: + type: string + description: An Array of scopes for authorization request + Audiences: + type: array + items: + type: string + description: An array of intended audiences for token requests + required: + - ClientSid + - Scopes + /v1/.well-known/openid-configuration: + servers: + - url: https://oauth.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - issuer + - authorization_endpoint + - device_authorization_endpoint + - token_endpoint + - userinfo_endpoint + - revocation_endpoint + - jwk_uri + - response_type_supported + - subject_type_supported + - id_token_signing_alg_values_supported + - scopes_supported + - claims_supported + pathType: instance + mountName: openid_discovery + get: + description: Fetch configuration details about the OpenID Connect Authorization + Server + tags: + - OauthV1OpenidDiscovery + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/oauth.v1.openid_discovery' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchOpenidDiscovery + x-maturity: + - GA + /v1/token: + servers: + - url: https://oauth.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - access_token + - access_token_expires_at + pathType: list + post: + description: Issues a new Access token (optionally identity_token & refresh_token) + in exchange of Oauth grant + tags: + - OauthV1Token + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/oauth.v1.token' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateToken + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateTokenRequest + properties: + GrantType: + type: string + description: Grant type is a credential representing resource owner's + authorization which can be used by client to obtain access token. + ClientSid: + type: string + description: A 34 character string that uniquely identifies this + OAuth App. + ClientSecret: + type: string + description: The credential for confidential OAuth App. + Code: + type: string + description: JWT token related to the authorization code grant type. + CodeVerifier: + type: string + description: A code which is generation cryptographically. + DeviceCode: + type: string + description: JWT token related to the device code grant type. + RefreshToken: + type: string + description: JWT token related to the refresh token grant type. + DeviceId: + type: string + description: The Id of the device associated with the token (refresh + token). + required: + - GrantType + - ClientSid + /v1/userinfo: + servers: + - url: https://oauth.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - user_sid + pathType: instance + mountName: user_info + get: + description: Retrieves the consented UserInfo and other claims about the logged-in + subject (end-user). + tags: + - OauthV1UserInfo + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/oauth.v1.user_info' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUserInfo + x-maturity: + - GA +servers: +- url: https://oauth.twilio.com +tags: +- name: OauthV1DeviceCode +- name: OauthV1Oauth +- name: OauthV1OpenidDiscovery +- name: OauthV1Token +- name: OauthV1UserInfo +x-maturity: +- name: GA + description: This product is Generally Available. diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index f42d021c..fec849a2 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -338,10 +338,6 @@ components: type: string nullable: true description: Email that this AuthorizationDocument will be sent to for signing. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -349,10 +345,6 @@ components: nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -447,20 +439,12 @@ components: type: string nullable: true description: A human readable description of this resource, up to 64 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' @@ -495,10 +479,6 @@ components: type: string nullable: true description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -506,10 +486,6 @@ components: nullable: true description: Email recipients who will be informed when an Authorization Document has been sent and signed - x-twilio: - pii: - handling: standard - deleteSla: 30 verification_type: type: string $ref: '#/components/schemas/dependent_hosted_number_order_enum_verification_type' @@ -631,20 +607,12 @@ components: nullable: true description: A 64 character string that is a human-readable text that describes this resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 unique_name: type: string nullable: true description: Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/hosted_number_order_enum_status' @@ -680,10 +648,6 @@ components: type: string nullable: true description: Email of the owner of this phone number that is being hosted. - x-twilio: - pii: - handling: standard - deleteSla: 30 cc_emails: type: array items: @@ -691,10 +655,6 @@ components: nullable: true description: A list of emails that LOA document for this HostedNumberOrder will be carbon copied to. - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -1370,270 +1330,927 @@ components: format: uri nullable: true description: Contains an absolute URL for this Sync Map Permission. - preview.wireless.command: + preview.understand.assistant: type: object properties: - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DC[0-9a-fA-F]{32}$ - nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - device_sid: + description: The unique ID of the Account that created this Assistant. + date_created: + type: string + format: date-time + nullable: true + description: The date that this resource was created + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was last updated + friendly_name: + type: string + nullable: true + description: A text description for the Assistant. It is non-unique and + can up to 255 characters long. + latest_model_build_sid: type: string minLength: 34 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^UG[0-9a-fA-F]{32}$ nullable: true - sim_sid: + description: The unique ID (Sid) of the latest model build. Null if no model + has been built. + links: + type: object + format: uri-map + nullable: true + log_queries: + type: boolean + nullable: true + description: A boolean that specifies whether queries should be logged for + 30 days further training. If false, no queries will be stored, if true, + queries will be stored for 30 days and deleted thereafter. + sid: type: string minLength: 34 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - command: + description: A 34 character string that uniquely identifies this resource. + unique_name: type: string nullable: true - command_mode: + description: A user-provided string that uniquely identifies this resource + as an alternative to the sid. You can use the unique name in the URL path. + Unique up to 64 characters long. + url: type: string + format: uri nullable: true - status: + callback_url: type: string + format: uri nullable: true - direction: + description: A user-provided URL to send event callbacks to. + callback_events: type: string nullable: true - date_created: + description: Space-separated list of callback events that will trigger callbacks. + preview.understand.assistant.assistant_fallback_actions: + type: object + properties: + account_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - date_updated: + assistant_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true - preview.wireless.rate_plan: + data: + nullable: true + preview.understand.assistant.assistant_initiation_actions: type: object properties: - sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - unique_name: + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + url: type: string + format: uri + nullable: true + data: nullable: true + preview.understand.assistant.dialogue: + type: object + properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - friendly_name: + description: The unique ID of the Account that created this Field. + assistant_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - data_enabled: - type: boolean - nullable: true - data_metering: + description: The unique ID of the parent Assistant. + sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^UK[0-9a-fA-F]{32}$ nullable: true - data_limit: - type: integer - nullable: true - messaging_enabled: - type: boolean - nullable: true - voice_enabled: - type: boolean + description: The unique ID of the Dialogue + data: nullable: true - national_roaming_enabled: - type: boolean + description: The dialogue memory object as json + url: + type: string + format: uri nullable: true - international_roaming: - type: array - items: - type: string + preview.understand.assistant.task.field: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true + description: The unique ID of the Account that created this Field. date_created: type: string format: date-time nullable: true + description: The date that this resource was created date_updated: type: string format: date-time nullable: true - url: + description: The date that this resource was last updated + field_type: type: string - format: uri nullable: true - preview.wireless.sim: - type: object - properties: - sid: + 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 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^UD[0-9a-fA-F]{32}$ nullable: true - unique_name: + description: The unique ID of the Task associated with this Field. + assistant_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - account_sid: + description: The unique ID of the parent Assistant. + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + pattern: ^UE[0-9a-fA-F]{32}$ nullable: true - rate_plan_sid: + description: A 34 character string that uniquely identifies this resource. + unique_name: + type: string + nullable: true + description: A user-provided string that uniquely identifies this resource + as an alternative to the sid. Unique up to 64 characters long. + url: + type: string + format: uri + nullable: true + preview.understand.assistant.field_type: + type: object + properties: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^WP[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - friendly_name: + description: The unique ID of the Account that created this Field Type. + date_created: type: string + format: date-time nullable: true - iccid: + description: The date that this resource was created + date_updated: type: string + format: date-time nullable: true - e_id: + description: The date that this resource was last updated + friendly_name: type: string nullable: true - status: - type: string + description: A user-provided string that identifies this resource. It is + non-unique and can up to 255 characters long. + links: + type: object + format: uri-map nullable: true - commands_callback_url: + assistant_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - commands_callback_method: + description: The unique ID of the Assistant. + sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ nullable: true - sms_fallback_method: + description: A 34 character string that uniquely identifies this resource. + unique_name: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE nullable: true - sms_fallback_url: + description: A user-provided string that uniquely identifies this resource + as an alternative to the sid. Unique up to 64 characters long. + url: type: string format: uri nullable: true - sms_method: + preview.understand.assistant.field_type.field_value: + type: object + properties: + account_sid: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - sms_url: + description: The unique ID of the Account that created this Field Value. + date_created: type: string - format: uri + format: date-time nullable: true - voice_fallback_method: + description: The date that this resource was created + date_updated: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE + format: date-time nullable: true - voice_fallback_url: + description: The date that this resource was last updated + field_type_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^UB[0-9a-fA-F]{32}$ nullable: true - voice_method: + description: The unique ID of the Field Type associated with this Field + Value. + language: type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE nullable: true - voice_url: + description: An ISO language-country string of the value. + assistant_sid: type: string - format: uri + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - date_created: + description: The unique ID of the Assistant. + sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ nullable: true - date_updated: + description: A 34 character string that uniquely identifies this resource. + value: type: string - format: date-time nullable: true + description: The Field Value itself. url: type: string format: uri nullable: true - links: - type: object - format: uri-map + synonym_of: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UC[0-9a-fA-F]{32}$ nullable: true - preview.wireless.sim.usage: + description: A value that indicates this field value is a synonym of. Empty + if the value is not a synonym. + preview.understand.assistant.model_build: type: object properties: - sim_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^DE[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - sim_unique_name: + description: The unique ID of the Account that created this Model Build. + date_created: type: string + format: date-time nullable: true - account_sid: + description: The date that this resource was created + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was last updated + assistant_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - period: - nullable: true - commands_usage: + pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - commands_costs: + description: The unique ID of the parent Assistant. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ nullable: true - data_usage: + description: A 34 character string that uniquely identifies this resource. + status: + type: string + $ref: '#/components/schemas/model_build_enum_status' nullable: true - data_costs: + description: 'A string that described the model build status. The values + can be: enqueued, building, completed, failed' + unique_name: + type: string nullable: true + description: A user-provided string that uniquely identifies this resource + as an alternative to the sid. Unique up to 64 characters long. url: type: string format: uri nullable: true - securitySchemes: - accountSid_authToken: - type: http - scheme: basic -info: - title: Twilio - Preview + build_duration: + type: integer + nullable: true + description: The time in seconds it took to build the model. + error_code: + type: integer + nullable: true + model_build_enum_status: + type: string + enum: + - enqueued + - building + - completed + - failed + - canceled + preview.understand.assistant.query: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Query. + date_created: + type: string + format: date-time + nullable: true + description: The date that this resource was created + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was last updated + results: + nullable: true + description: The natural language analysis results which include the Task + recognized, the confidence score and a list of identified Fields. + language: + type: string + nullable: true + description: An ISO language-country string of the sample. + model_build_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UG[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Model Build queried. + query: + type: string + nullable: true + description: The end-user's natural language input. + sample_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + nullable: true + description: An optional reference to the Sample created from this query. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the parent Assistant. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UH[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this resource. + status: + type: string + nullable: true + description: 'A string that described the query status. The values can be: + pending_review, reviewed, discarded' + url: + type: string + format: uri + nullable: true + source_channel: + type: string + nullable: true + description: The communication channel where this end-user input came from + preview.understand.assistant.task.sample: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Sample. + date_created: + type: string + format: date-time + nullable: true + description: The date that this resource was created + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was last updated + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Task associated with this Sample. + language: + type: string + nullable: true + description: An ISO language-country string of the sample. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Assistant. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this resource. + tagged_text: + type: string + nullable: true + description: The text example of how end-users may express this task. The + sample may contain Field tag blocks. + url: + type: string + format: uri + nullable: true + source_channel: + type: string + nullable: true + description: 'The communication channel the sample was captured. It can + be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If + not included the value will be null' + preview.understand.assistant.style_sheet: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Assistant + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Assistant + url: + type: string + format: uri + nullable: true + data: + nullable: true + description: The JSON style sheet object + preview.understand.assistant.task: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Task. + date_created: + type: string + format: date-time + nullable: true + description: The date that this resource was created + date_updated: + type: string + format: date-time + nullable: true + description: The date that this resource was last updated + friendly_name: + type: string + nullable: true + description: A user-provided string that identifies this resource. It is + non-unique and can up to 255 characters long. + links: + type: object + format: uri-map + nullable: true + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Assistant. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: A 34 character string that uniquely identifies this resource. + unique_name: + type: string + nullable: true + description: A user-provided string that uniquely identifies this resource + as an alternative to the sid. Unique up to 64 characters long. + actions_url: + type: string + format: uri + nullable: true + description: User-provided HTTP endpoint where from the assistant fetches + actions + url: + type: string + format: uri + nullable: true + preview.understand.assistant.task.task_actions: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Field. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the parent Assistant. + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Task. + url: + type: string + format: uri + nullable: true + data: + nullable: true + preview.understand.assistant.task.task_statistics: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Account that created this Field. + assistant_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UA[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the parent Assistant. + task_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UD[0-9a-fA-F]{32}$ + nullable: true + description: The unique ID of the Task associated with this Field. + samples_count: + type: integer + nullable: true + description: The total number of Samples associated with this Task. + fields_count: + type: integer + nullable: true + description: The total number of Fields associated with this Task. + url: + type: string + format: uri + nullable: true + preview.wireless.command: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DC[0-9a-fA-F]{32}$ + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + device_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + nullable: true + sim_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + nullable: true + command: + type: string + nullable: true + command_mode: + type: string + nullable: true + status: + type: string + nullable: true + direction: + type: string + nullable: true + date_created: + type: string + format: date-time + nullable: true + date_updated: + type: string + format: date-time + nullable: true + url: + type: string + format: uri + nullable: true + preview.wireless.rate_plan: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + nullable: true + unique_name: + type: string + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + friendly_name: + type: string + nullable: true + data_enabled: + type: boolean + nullable: true + data_metering: + type: string + nullable: true + data_limit: + type: integer + nullable: true + messaging_enabled: + type: boolean + nullable: true + voice_enabled: + type: boolean + nullable: true + national_roaming_enabled: + type: boolean + nullable: true + international_roaming: + type: array + items: + type: string + nullable: true + date_created: + type: string + format: date-time + nullable: true + date_updated: + type: string + format: date-time + nullable: true + url: + type: string + format: uri + nullable: true + preview.wireless.sim: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + nullable: true + unique_name: + type: string + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + rate_plan_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ + nullable: true + friendly_name: + type: string + nullable: true + iccid: + type: string + nullable: true + e_id: + type: string + nullable: true + status: + type: string + nullable: true + commands_callback_url: + type: string + format: uri + nullable: true + commands_callback_method: + type: string + nullable: true + sms_fallback_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + nullable: true + sms_fallback_url: + type: string + format: uri + nullable: true + sms_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + nullable: true + sms_url: + type: string + format: uri + nullable: true + voice_fallback_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + nullable: true + voice_fallback_url: + type: string + format: uri + nullable: true + voice_method: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + nullable: true + voice_url: + type: string + format: uri + nullable: true + date_created: + type: string + format: date-time + nullable: true + date_updated: + type: string + format: date-time + nullable: true + url: + type: string + format: uri + nullable: true + links: + type: object + format: uri-map + nullable: true + preview.wireless.sim.usage: + type: object + properties: + sim_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DE[0-9a-fA-F]{32}$ + nullable: true + sim_unique_name: + type: string + nullable: true + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + period: + nullable: true + commands_usage: + nullable: true + commands_costs: + nullable: true + data_usage: + nullable: true + data_costs: + nullable: true + url: + type: string + format: uri + nullable: true + securitySchemes: + accountSid_authToken: + type: http + scheme: basic +info: + title: Twilio - Preview description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: @@ -1643,7 +2260,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: @@ -1653,153 +2270,1898 @@ paths: x-twilio: defaultOutputProperties: [] pathType: instance - parent: /Fleets/{Sid} + parent: /Fleets/{Sid} + get: + description: Fetch information about a specific Certificate credential in the + Fleet. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesCertificate + x-maturity: + - Preview + delete: + description: Unregister a specific Certificate credential from the Fleet, effectively + disallowing any inbound client connections that are presenting it. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesCertificate + x-maturity: + - Preview + post: + description: Update the given properties of a specific Certificate credential + in the Fleet, giving it a friendly name or assigning to a Device. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CY[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesCertificate + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesCertificateRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + /DeployedDevices/Fleets/{FleetSid}/Certificates: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Fleets/{Sid} + post: + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesCertificate + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesCertificateRequest + properties: + CertificateData: + type: string + description: Provides a URL encoded representation of the public + certificate in PEM format. + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Certificate credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Certificate credential. + required: + - CertificateData + get: + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: DeviceSid + in: query + description: Filters the resulting list of Certificates by a unique string + identifier of an authenticated Device. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDeployedDevicesCertificateResponse + properties: + certificates: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesCertificate + x-maturity: + - Preview + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Fleets/{Sid} + get: + description: Fetch information about a specific Deployment in the Fleet. + tags: + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesDeployment + x-maturity: + - Preview + delete: + description: Delete a specific Deployment from the Fleet, leaving associated + devices effectively undeployed. + tags: + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesDeployment + x-maturity: + - Preview + post: + description: Update the given properties of a specific Deployment credential + in the Fleet, giving it a friendly name or linking to a specific Twilio Sync + service instance. + tags: + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Deployment resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesDeployment + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesDeploymentRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Deployment, up to 64 characters long + SyncServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + /DeployedDevices/Fleets/{FleetSid}/Deployments: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Fleets/{Sid} + post: + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. + tags: + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesDeployment + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesDeploymentRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Deployment, up to 256 characters long. + SyncServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. + get: + description: Retrieve a list of all Deployments belonging to the Fleet. + tags: + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDeployedDevicesDeploymentResponse + properties: + deployments: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesDeployment + x-maturity: + - Preview + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Fleets/{Sid} + get: + description: Fetch information about a specific Device in the Fleet. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesDevice + x-maturity: + - Preview + delete: + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesDevice + x-maturity: + - Preview + post: + description: Update the given properties of a specific Device in the Fleet, + giving it a friendly name, assigning to a Deployment, or a human identity. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesDevice + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesDeviceRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + Identity: + type: string + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + DeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + Enabled: + type: boolean + description: '' + /DeployedDevices/Fleets/{FleetSid}/Devices: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Fleets/{Sid} + post: + description: Create a new Device in the Fleet, optionally giving it a unique + name, friendly name, and assigning to a Deployment and/or human identity. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesDevice + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesDeviceRequest + properties: + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this Device, to be used in addition to SID, up to 128 characters + long. + FriendlyName: + type: string + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + Identity: + type: string + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + DeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + Enabled: + type: boolean + description: '' + get: + description: Retrieve a list of all Devices belonging to the Fleet. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: DeploymentSid + in: query + description: Filters the resulting list of Devices by a unique string identifier + of the Deployment they are associated with. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDeployedDevicesDeviceResponse + properties: + devices: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesDevice + x-maturity: + - Preview + /DeployedDevices/Fleets/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + dependentProperties: + devices: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys + get: + description: Fetch information about a specific Fleet in your account. + tags: + - PreviewDeployedDevicesFleet + parameters: + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesFleet + x-maturity: + - Preview + delete: + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' + tags: + - PreviewDeployedDevicesFleet + parameters: + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesFleet + x-maturity: + - Preview + post: + description: Update the friendly name property of a specific Fleet in your account. + tags: + - PreviewDeployedDevicesFleet + parameters: + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesFleet + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesFleetRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + DefaultDeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Provides a string identifier of a Deployment that is + going to be used as a default one for this Fleet. + /DeployedDevices/Fleets: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + devices: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys + post: + description: Create a new Fleet for scoping of deployed devices within your + account. + tags: + - PreviewDeployedDevicesFleet + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesFleet + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesFleetRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + get: + description: Retrieve a list of all Fleets belonging to your account. + tags: + - PreviewDeployedDevicesFleet + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDeployedDevicesFleetResponse + properties: + fleets: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesFleet + x-maturity: + - Preview + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Fleets/{Sid} + get: + description: Fetch information about a specific Key credential in the Fleet. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesKey + x-maturity: + - Preview + delete: + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesKey + x-maturity: + - Preview + post: + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Key credential resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KY[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesKey + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateDeployedDevicesKeyRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + /DeployedDevices/Fleets/{FleetSid}/Keys: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Fleets/{Sid} + post: + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesKey + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesKeyRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + get: + description: Retrieve a list of all Keys credentials belonging to the Fleet. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: DeviceSid + in: query + description: Filters the resulting list of Keys by a unique string identifier + of an authenticated Device. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListDeployedDevicesKeyResponse + properties: + keys: + type: array + items: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListDeployedDevicesKey + x-maturity: + - Preview + /HostedNumbers/AuthorizationDocuments/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + get: + description: Fetch a specific AuthorizationDocument. + tags: + - PreviewHostedNumbersAuthorizationDocument + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchHostedNumbersAuthorizationDocument + x-maturity: + - Preview + post: + description: Updates a specific AuthorizationDocument. + tags: + - PreviewHostedNumbersAuthorizationDocument + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this AuthorizationDocument. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateHostedNumbersAuthorizationDocument + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateHostedNumbersAuthorizationDocumentRequest + properties: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed + Status: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + description: 'Status of an instance resource. It can hold one of + the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, + 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + /HostedNumbers/AuthorizationDocuments: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + get: + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. + tags: + - PreviewHostedNumbersAuthorizationDocument + parameters: + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. + schema: + type: string + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListHostedNumbersAuthorizationDocumentResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListHostedNumbersAuthorizationDocument + x-maturity: + - Preview + post: + description: Create an AuthorizationDocument for authorizing the hosting of + phone number capabilities on Twilio's platform. + tags: + - PreviewHostedNumbersAuthorizationDocument + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateHostedNumbersAuthorizationDocument + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateHostedNumbersAuthorizationDocumentRequest + properties: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: A 34 character string that uniquely identifies the + Address resource that is associated with this AuthorizationDocument. + Email: + type: string + description: Email that this AuthorizationDocument will be sent + to for signing. + ContactTitle: + type: string + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. + CcEmails: + type: array + items: + type: string + description: Email recipients who will be informed when an Authorization + Document has been sent and signed. + required: + - HostedNumberOrderSids + - AddressSid + - Email + - ContactTitle + - ContactPhoneNumber + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /AuthorizationDocuments/{Sid} + get: + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. + tags: + - PreviewHostedNumbersDependentHostedNumberOrder + parameters: + - name: SigningDocumentSid + in: path + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PX[0-9a-fA-F]{32}$ + required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListHostedNumbersDependentHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListHostedNumbersDependentHostedNumberOrder + x-maturity: + - Preview + /HostedNumbers/HostedNumberOrders/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance get: - description: Fetch information about a specific Certificate credential in the - Fleet. + description: Fetch a specific HostedNumberOrder. tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesCertificate + operationId: FetchHostedNumbersHostedNumberOrder x-maturity: - Preview delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesCertificate + operationId: DeleteHostedNumbersHostedNumberOrder x-maturity: - Preview post: - description: Update the given properties of a specific Certificate credential - in the Fleet, giving it a friendly name or assigning to a Device. + description: Updates a specific HostedNumberOrder. tags: - - PreviewDeployedDevicesCertificate + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: FleetSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HR[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateHostedNumbersHostedNumberOrder + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateHostedNumbersHostedNumberOrderRequest + properties: + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this HostedNumberOrder, assigned by the developer, to be optionally + used in addition to SID. + Email: + type: string + description: Email of the owner of this phone number that is being + hosted. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + Status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + description: User can only post to `pending-verification` status + to transition the HostedNumberOrder to initiate a verification + call or verification of ownership with a copy of a phone bill. + VerificationCode: + type: string + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + Extension: + type: string + description: Digits to dial after connecting the verification call. + CallDelay: + type: integer + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. + /HostedNumbers/HostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + get: + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. + tags: + - PreviewHostedNumbersHostedNumberOrder + parameters: + - name: Status + in: query + description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, + `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, + `failed`, or `action-required`. + schema: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Certificate credential resource. + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^CY[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + type: object + title: ListHostedNumbersHostedNumberOrderResponse + properties: + items: + type: array + items: + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesCertificate + operationId: ListHostedNumbersHostedNumberOrder x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesCertificateRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. - /DeployedDevices/Fleets/{FleetSid}/Certificates: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. + description: Host a phone number's capability on Twilio's platform. tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true + - PreviewHostedNumbersHostedNumberOrder responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' description: Created security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesCertificate + operationId: CreateHostedNumbersHostedNumberOrder x-maturity: - Preview requestBody: @@ -1807,46 +4169,188 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesCertificateRequest + title: CreateHostedNumbersHostedNumberOrderRequest properties: - CertificateData: + PhoneNumber: type: string - description: Provides a URL encoded representation of the public - certificate in PEM format. + format: phone-number + description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) + format + SmsCapability: + type: boolean + description: Used to specify that the SMS capability will be hosted + on Twilio's platform. + AccountSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + description: This defaults to the AccountSid of the authorization + the user is using. This can be provided to specify a subaccount + to add the HostedNumberOrder to. FriendlyName: type: string - description: Provides a human readable descriptive text for this - Certificate credential, up to 256 characters long. - DeviceSid: + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Optional. Provides a unique and addressable name to + be assigned to this HostedNumberOrder, assigned by the developer, + to be optionally used in addition to SID. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that the LOA document for + this HostedNumberOrder will be carbon copied to. + SmsUrl: + type: string + format: uri + description: The URL that Twilio should request when somebody sends + an SMS to the phone number. This will be copied onto the IncomingPhoneNumber + resource. + SmsMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsUrl. Must be either `GET` or `POST`. This will be copied onto + the IncomingPhoneNumber resource. + SmsFallbackUrl: + type: string + format: uri + description: A URL that Twilio will request if an error occurs requesting + or executing the TwiML defined by SmsUrl. This will be copied + onto the IncomingPhoneNumber resource. + SmsFallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: The HTTP method that should be used to request the + SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied + onto the IncomingPhoneNumber resource. + StatusCallbackUrl: + type: string + format: uri + description: Optional. The Status Callback URL attached to the IncomingPhoneNumber + resource. + StatusCallbackMethod: + type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE + description: Optional. The Status Callback Method attached to the + IncomingPhoneNumber resource. + SmsApplicationSid: type: string minLength: 34 maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Certificate credential. + pattern: ^AP[0-9a-fA-F]{32}$ + description: Optional. The 34 character sid of the application Twilio + should use to handle SMS messages sent to this number. If a `SmsApplicationSid` + is present, Twilio will ignore all of the SMS urls above and use + those set on the application. + AddressSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AD[0-9a-fA-F]{32}$ + description: Optional. A 34 character string that uniquely identifies + the Address resource that represents the address of the owner + of this phone number. + Email: + type: string + description: Optional. Email of the owner of this phone number that + is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. required: - - CertificateData + - PhoneNumber + - SmsCapability + /marketplace/AvailableAddOns/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions get: - description: Retrieve a list of all Certificate credentials belonging to the - Fleet. + description: Fetch an instance of an Add-on currently available to be installed. tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: DeviceSid - in: query - description: Filters the resulting list of Certificates by a unique string - identifier of an authenticated Device. + - PreviewMarketplaceAvailableAddOn + parameters: + - name: Sid + in: path + description: The SID of the AvailableAddOn resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.available_add_on' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceAvailableAddOn + x-maturity: + - Preview + /marketplace/AvailableAddOns: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + get: + description: Retrieve a list of Add-ons currently available to be installed. + tags: + - PreviewMarketplaceAvailableAddOn + parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1872,12 +4376,12 @@ paths: application/json: schema: type: object - title: ListDeployedDevicesCertificateResponse + title: ListMarketplaceAvailableAddOnResponse properties: - certificates: + available_add_ons: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' + $ref: '#/components/schemas/preview.marketplace.available_add_on' meta: type: object properties: @@ -1904,164 +4408,168 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesCertificate + operationId: ListMarketplaceAvailableAddOn x-maturity: - Preview - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - parent: /Fleets/{Sid} + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension get: - description: Fetch information about a specific Deployment in the Fleet. + description: Fetch an instance of an Extension for the Available Add-on. tags: - - PreviewDeployedDevicesDeployment + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: FleetSid + - name: AvailableAddOnSid in: path - description: '' + description: The SID of the AvailableAddOn resource with the extension to + fetch. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. + description: The SID of the AvailableAddOn Extension resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesDeployment + operationId: FetchMarketplaceAvailableAddOnExtension x-maturity: - Preview - delete: - description: Delete a specific Deployment from the Fleet, leaving associated - devices effectively undeployed. + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension + get: + description: Retrieve a list of Extensions for the Available Add-on. tags: - - PreviewDeployedDevicesDeployment + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid + - name: AvailableAddOnSid in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. + description: The SID of the AvailableAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesDeployment - x-maturity: - - Preview - post: - description: Update the given properties of a specific Deployment credential - in the Fleet, giving it a friendly name or linking to a specific Twilio Sync - service instance. - tags: - - PreviewDeployedDevicesDeployment - parameters: - - name: FleetSid - in: path - description: '' + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Deployment resource. + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + type: object + title: ListMarketplaceAvailableAddOnExtensionResponse + properties: + extensions: + type: array + items: + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDeployment + operationId: ListMarketplaceAvailableAddOnExtension x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesDeploymentRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Deployment, up to 64 characters long - SyncServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - /DeployedDevices/Fleets/{FleetSid}/Deployments: + /marketplace/InstalledAddOns: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Fleets/{Sid} + dependentProperties: + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. + description: Install an Add-on for the Account specified. tags: - - PreviewDeployedDevicesDeployment - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true + - PreviewMarketplaceInstalledAddOn responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' description: Created security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesDeployment + operationId: CreateMarketplaceInstalledAddOn x-maturity: - Preview requestBody: @@ -2069,31 +4577,32 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesDeploymentRequest + title: CreateMarketplaceInstalledAddOnRequest properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - SyncServiceSid: + AvailableAddOnSid: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. + pattern: ^XB[0-9a-fA-F]{32}$ + description: The SID of the AvaliableAddOn to install. + AcceptTermsOfService: + type: boolean + description: Whether the Terms of Service were accepted. + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + required: + - AvailableAddOnSid + - AcceptTermsOfService get: - description: Retrieve a list of all Deployments belonging to the Fleet. + description: Retrieve a list of Add-ons currently installed on this Account. tags: - - PreviewDeployedDevicesDeployment + - PreviewMarketplaceInstalledAddOn parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2119,12 +4628,12 @@ paths: application/json: schema: type: object - title: ListDeployedDevicesDeploymentResponse + title: ListMarketplaceInstalledAddOnResponse properties: - deployments: + installed_add_ons: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' meta: type: object properties: @@ -2151,103 +4660,97 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesDeployment + operationId: ListMarketplaceInstalledAddOn x-maturity: - Preview - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: + /marketplace/InstalledAddOns/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - parent: /Fleets/{Sid} - get: - description: Fetch information about a specific Device in the Fleet. + dependentProperties: + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + delete: + description: Remove an Add-on installation from your account tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceInstalledAddOn parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. + description: The SID of the InstalledAddOn resource to delete. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesDevice + operationId: DeleteMarketplaceInstalledAddOn x-maturity: - Preview - delete: - description: Delete a specific Device from the Fleet, also removing it from - associated Deployments. + get: + description: Fetch an instance of an Add-on currently installed on this Account. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceInstalledAddOn parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. + description: The SID of the InstalledAddOn resource to fetch. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + description: OK security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesDevice + operationId: FetchMarketplaceInstalledAddOn x-maturity: - Preview post: - description: Update the given properties of a specific Device in the Fleet, - giving it a friendly name, assigning to a Deployment, or a human identity. + description: Update an Add-on installation for the Account specified. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceInstalledAddOn parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. + description: The SID of the InstalledAddOn resource to update. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDevice + operationId: UpdateMarketplaceInstalledAddOn x-maturity: - Preview requestBody: @@ -2255,57 +4758,95 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateDeployedDevicesDeviceRequest + title: UpdateMarketplaceInstalledAddOnRequest properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: - type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: + Configuration: + description: Valid JSON object that conform to the configuration + schema exposed by the associated AvailableAddOn resource. This + is only required by Add-ons that need to be configured + UniqueName: type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - Enabled: - type: boolean - description: '' - /DeployedDevices/Fleets/{FleetSid}/Devices: + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] - pathType: list - parent: /Fleets/{Sid} + pathType: instance + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + get: + description: Fetch an instance of an Extension for the Installed Add-on. + tags: + - PreviewMarketplaceInstalledAddOnExtension + parameters: + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extension to + fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the InstalledAddOn Extension resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceInstalledAddOnExtension + x-maturity: + - Preview post: - description: Create a new Device in the Fleet, optionally giving it a unique - name, friendly name, and assigning to a Deployment and/or human identity. + description: Update an Extension for an Add-on installation. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: FleetSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extension to + update. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the InstalledAddOn Extension resource to update. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' - description: Created + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + description: OK security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesDevice + operationId: UpdateMarketplaceInstalledAddOnExtension x-maturity: - Preview requestBody: @@ -2313,52 +4854,37 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesDeviceRequest + title: UpdateMarketplaceInstalledAddOnExtensionRequest properties: - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this Device, to be used in addition to SID, up to 128 characters - long. - FriendlyName: - type: string - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: - type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. Enabled: type: boolean - description: '' + description: Whether the Extension should be invoked. + required: + - Enabled + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension get: - description: Retrieve a list of all Devices belonging to the Fleet. + description: Retrieve a list of Extensions for the Installed Add-on. tags: - - PreviewDeployedDevicesDevice + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: FleetSid + - name: InstalledAddOnSid in: path - description: '' - schema: - type: string - required: true - - name: DeploymentSid - in: query - description: Filters the resulting list of Devices by a unique string identifier - of the Deployment they are associated with. + description: The SID of the InstalledAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2384,12 +4910,12 @@ paths: application/json: schema: type: object - title: ListDeployedDevicesDeviceResponse + title: ListMarketplaceInstalledAddOnExtensionResponse properties: - devices: + extensions: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.device' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' meta: type: object properties: @@ -2416,10 +4942,10 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesDevice + operationId: ListMarketplaceInstalledAddOnExtension x-maturity: - Preview - /DeployedDevices/Fleets/{Sid}: + /Sync/Services/{ServiceSid}/Documents/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -2427,31 +4953,29 @@ paths: defaultOutputProperties: [] pathType: instance dependentProperties: - devices: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices - deployments: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments - certificates: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates - keys: + document_permissions: mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys + service_sid: service_sid + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions + parent: /Services/{Sid} get: - description: Fetch information about a specific Fleet in your account. + description: '' tags: - - PreviewDeployedDevicesFleet + - PreviewSyncDocument parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. + description: '' schema: type: string required: true @@ -2460,23 +4984,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.sync.service.document' description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesFleet + operationId: FetchSyncDocument x-maturity: - Preview delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' + description: '' tags: - - PreviewDeployedDevicesFleet + - PreviewSyncDocument parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. + description: '' schema: type: string required: true @@ -2485,31 +5016,44 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesFleet + operationId: DeleteSyncDocument x-maturity: - Preview post: - description: Update the friendly name property of a specific Fleet in your account. + description: '' tags: - - PreviewDeployedDevicesFleet + - PreviewSyncDocument parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: Sid in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. + description: '' schema: type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.sync.service.document' description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesFleet + operationId: UpdateSyncDocument x-maturity: - Preview requestBody: @@ -2517,20 +5061,13 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateDeployedDevicesFleetRequest + title: UpdateSyncDocumentRequest properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - DefaultDeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Provides a string identifier of a Deployment that is - going to be used as a default one for this Fleet. - /DeployedDevices/Fleets: + Data: + description: '' + required: + - Data + /Sync/Services/{ServiceSid}/Documents: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -2538,37 +5075,36 @@ paths: defaultOutputProperties: [] pathType: list dependentProperties: - devices: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices - deployments: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments - certificates: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates - keys: + document_permissions: mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys + service_sid: service_sid + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions + parent: /Services/{Sid} post: - description: Create a new Fleet for scoping of deployed devices within your - account. + description: '' tags: - - PreviewDeployedDevicesFleet + - PreviewSyncDocument + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.sync.service.document' description: Created security: - accountSid_authToken: [] - operationId: CreateDeployedDevicesFleet + operationId: CreateSyncDocument x-maturity: - Preview requestBody: @@ -2576,17 +5112,27 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateDeployedDevicesFleetRequest + title: CreateSyncDocumentRequest properties: - FriendlyName: + UniqueName: type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. + description: '' + Data: + description: '' get: - description: Retrieve a list of all Fleets belonging to your account. + description: '' tags: - - PreviewDeployedDevicesFleet + - PreviewSyncDocument parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2612,12 +5158,12 @@ paths: application/json: schema: type: object - title: ListDeployedDevicesFleetResponse + title: ListSyncDocumentResponse properties: - fleets: + documents: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet' + $ref: '#/components/schemas/preview.sync.service.document' meta: type: object properties: @@ -2644,112 +5190,129 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesFleet + operationId: ListSyncDocument x-maturity: - Preview - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - parent: /Fleets/{Sid} + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions get: - description: Fetch information about a specific Key credential in the Fleet. + description: Fetch a specific Sync Document Permission. tags: - - PreviewDeployedDevicesKey + - PreviewSyncDocumentPermission parameters: - - name: FleetSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: DocumentSid in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' description: OK security: - accountSid_authToken: [] - operationId: FetchDeployedDevicesKey + operationId: FetchSyncDocumentPermission x-maturity: - Preview delete: - description: Delete a specific Key credential from the Fleet, effectively disallowing - any inbound client connections that are presenting it. + description: Delete a specific Sync Document Permission. tags: - - PreviewDeployedDevicesKey + - PreviewSyncDocumentPermission parameters: - - name: FleetSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: DocumentSid in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteDeployedDevicesKey + operationId: DeleteSyncDocumentPermission x-maturity: - Preview post: - description: Update the given properties of a specific Key credential in the - Fleet, giving it a friendly name or assigning to a Device. + description: Update an identity's access to a specific Sync Document. tags: - - PreviewDeployedDevicesKey + - PreviewSyncDocumentPermission parameters: - - name: FleetSid + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: Sid + - name: Identity in: path - description: Provides a 34 character string that uniquely identifies the requested - Key credential resource. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^KY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' description: OK security: - accountSid_authToken: [] - operationId: UpdateDeployedDevicesKey + operationId: UpdateSyncDocumentPermission x-maturity: - Preview requestBody: @@ -2757,89 +5320,53 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateDeployedDevicesKeyRequest + title: UpdateSyncDocumentPermissionRequest properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - /DeployedDevices/Fleets/{FleetSid}/Keys: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Document. + Write: + type: boolean + description: Boolean flag specifying whether the identity can update + the Sync Document. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Document. + required: + - Read + - Write + - Manage + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Fleets/{Sid} - post: - description: Create a new Key credential in the Fleet, optionally giving it - a friendly name and assigning to a Device. + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions + get: + description: Retrieve a list of all Permissions applying to a Sync Document. tags: - - PreviewDeployedDevicesKey + - PreviewSyncDocumentPermission parameters: - - name: FleetSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesKey - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesKeyRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - get: - description: Retrieve a list of all Keys credentials belonging to the Fleet. - tags: - - PreviewDeployedDevicesKey - parameters: - - name: FleetSid + - name: DocumentSid in: path - description: '' + description: Identifier of the Sync Document. Either a SID or a unique name. schema: type: string required: true - - name: DeviceSid - in: query - description: Filters the resulting list of Keys by a unique string identifier - of an authenticated Device. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2865,12 +5392,12 @@ paths: application/json: schema: type: object - title: ListDeployedDevicesKeyResponse + title: ListSyncDocumentPermissionResponse properties: - keys: + permissions: type: array items: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' meta: type: object properties: @@ -2897,10 +5424,10 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListDeployedDevicesKey + operationId: ListSyncDocumentPermission x-maturity: - Preview - /HostedNumbers/AuthorizationDocuments/{Sid}: + /Sync/Services/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -2908,60 +5435,90 @@ paths: defaultOutputProperties: [] pathType: instance dependentProperties: - dependent_hosted_number_orders: + documents: mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps get: - description: Fetch a specific AuthorizationDocument. + description: '' tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewSyncService parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this AuthorizationDocument. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.sync.service' description: OK security: - accountSid_authToken: [] - operationId: FetchHostedNumbersAuthorizationDocument + operationId: FetchSyncService + x-maturity: + - Preview + delete: + description: '' + tags: + - PreviewSyncService + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncService x-maturity: - Preview post: - description: Updates a specific AuthorizationDocument. + description: '' tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewSyncService parameters: - name: Sid in: path - description: A 34 character string that uniquely identifies this AuthorizationDocument. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.sync.service' description: OK security: - accountSid_authToken: [] - operationId: UpdateHostedNumbersAuthorizationDocument + operationId: UpdateSyncService x-maturity: - Preview requestBody: @@ -2969,83 +5526,82 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateHostedNumbersAuthorizationDocumentRequest + title: UpdateSyncServiceRequest properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: + WebhookUrl: type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - Status: + format: uri + description: '' + FriendlyName: type: string - $ref: '#/components/schemas/authorization_document_enum_status' - description: 'Status of an instance resource. It can hold one of - the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, - 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - ContactTitle: + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + /Sync/Services: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps + post: + description: '' + tags: + - PreviewSyncService + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncService + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncServiceRequest + properties: + FriendlyName: type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: + description: '' + WebhookUrl: type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - /HostedNumbers/AuthorizationDocuments: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - dependentProperties: - dependent_hosted_number_orders: - mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + format: uri + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' get: - description: Retrieve a list of AuthorizationDocuments belonging to the account - initiating the request. + description: '' tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewSyncService parameters: - - name: Email - in: query - description: Email that this AuthorizationDocument will be sent to for signing. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3071,12 +5627,12 @@ paths: application/json: schema: type: object - title: ListHostedNumbersAuthorizationDocumentResponse + title: ListSyncServiceResponse properties: - items: + services: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' + $ref: '#/components/schemas/preview.sync.service' meta: type: object properties: @@ -3103,139 +5659,159 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersAuthorizationDocument + operationId: ListSyncService x-maturity: - Preview - post: - description: Create an AuthorizationDocument for authorizing the hosting of - phone number capabilities on Twilio's platform. + /Sync/Services/{ServiceSid}/Lists/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + dependentProperties: + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists + get: + description: '' tags: - - PreviewHostedNumbersAuthorizationDocument + - PreviewSyncSyncList + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - description: Created + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: OK security: - accountSid_authToken: [] - operationId: CreateHostedNumbersAuthorizationDocument + operationId: FetchSyncSyncList x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed. - required: - - HostedNumberOrderSids - - AddressSid - - Email - - ContactTitle - - ContactPhoneNumber - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + delete: + description: '' + tags: + - PreviewSyncSyncList + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncList + x-maturity: + - Preview + /Sync/Services/{ServiceSid}/Lists: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - parent: /AuthorizationDocuments/{Sid} - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. + dependentProperties: + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists + post: + description: '' tags: - - PreviewHostedNumbersDependentHostedNumberOrder + - PreviewSyncSyncList parameters: - - name: SigningDocumentSid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies the LOA document - associated with this HostedNumberOrder. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncSyncList + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncSyncListRequest + properties: + UniqueName: + type: string + description: '' + get: + description: '' + tags: + - PreviewSyncSyncList + parameters: + - name: ServiceSid + in: path + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3261,12 +5837,12 @@ paths: application/json: schema: type: object - title: ListHostedNumbersDependentHostedNumberOrderResponse + title: ListSyncSyncListResponse properties: - items: + lists: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' + $ref: '#/components/schemas/preview.sync.service.sync_list' meta: type: object properties: @@ -3293,89 +5869,136 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersDependentHostedNumberOrder + operationId: ListSyncSyncList x-maturity: - Preview - /HostedNumbers/HostedNumberOrders/{Sid}: + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items get: - description: Fetch a specific HostedNumberOrder. + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewSyncSyncListItem parameters: - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + - name: Index + in: path + description: '' + schema: + type: integer required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' description: OK security: - accountSid_authToken: [] - operationId: FetchHostedNumbersHostedNumberOrder + operationId: FetchSyncSyncListItem x-maturity: - Preview delete: - description: Cancel the HostedNumberOrder (only available when the status is - in `received`). + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewSyncSyncListItem parameters: - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + - name: Index + in: path + description: '' + schema: + type: integer + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteHostedNumbersHostedNumberOrder + operationId: DeleteSyncSyncListItem x-maturity: - Preview post: - description: Updates a specific HostedNumberOrder. + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewSyncSyncListItem parameters: - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this HostedNumberOrder. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^HR[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + - name: Index + in: path + description: '' + schema: + type: integer required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' description: OK security: - accountSid_authToken: [] - operationId: UpdateHostedNumbersHostedNumberOrder + operationId: UpdateSyncSyncListItem x-maturity: - Preview requestBody: @@ -3383,114 +6006,101 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateHostedNumbersHostedNumberOrderRequest + title: UpdateSyncSyncListItemRequest properties: - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this HostedNumberOrder, assigned by the developer, to be optionally - used in addition to SID. - Email: - type: string - description: Email of the owner of this phone number that is being - hosted. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that LOA document for this - HostedNumberOrder will be carbon copied to. - Status: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - description: User can only post to `pending-verification` status - to transition the HostedNumberOrder to initiate a verification - call or verification of ownership with a copy of a phone bill. - VerificationCode: - type: string - description: A verification code that is given to the user via a - phone call to the phone number that is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - Extension: - type: string - description: Digits to dial after connecting the verification call. - CallDelay: - type: integer - description: The number of seconds, between 0 and 60, to delay before - initiating the verification call. Defaults to 0. - /HostedNumbers/HostedNumberOrders: + Data: + description: '' + required: + - Data + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items + post: + description: '' + tags: + - PreviewSyncSyncListItem + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncSyncListItem + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncSyncListItemRequest + properties: + Data: + description: '' + required: + - Data get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. + description: '' tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewSyncSyncListItem parameters: - - name: Status - in: query - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. + - name: ServiceSid + in: path + description: '' schema: type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' schema: type: string - format: phone-number - - name: IncomingPhoneNumberSid + required: true + - name: Order in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - - name: FriendlyName + $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + - name: From in: query - description: A human readable description of this resource, up to 64 characters. + description: '' schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - - name: UniqueName + - name: Bounds in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. + description: '' schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 + $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3516,12 +6126,12 @@ paths: application/json: schema: type: object - title: ListHostedNumbersHostedNumberOrderResponse + title: ListSyncSyncListItemResponse properties: items: type: array items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' meta: type: object properties: @@ -3548,212 +6158,183 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListHostedNumbersHostedNumberOrder + operationId: ListSyncSyncListItem x-maturity: - Preview - post: - description: Host a phone number's capability on Twilio's platform. + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions + get: + description: Fetch a specific Sync List Permission. tags: - - PreviewHostedNumbersHostedNumberOrder + - PreviewSyncSyncListPermission + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - description: Created + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + description: OK security: - accountSid_authToken: [] - operationId: CreateHostedNumbersHostedNumberOrder + operationId: FetchSyncSyncListPermission x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersHostedNumberOrderRequest - properties: - PhoneNumber: - type: string - format: phone-number - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - SmsCapability: - type: boolean - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - AccountSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - description: This defaults to the AccountSid of the authorization - the user is using. This can be provided to specify a subaccount - to add the HostedNumberOrder to. - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Optional. Provides a unique and addressable name to - be assigned to this HostedNumberOrder, assigned by the developer, - to be optionally used in addition to SID. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - SmsUrl: - type: string - format: uri - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - SmsMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsUrl. Must be either `GET` or `POST`. This will be copied onto - the IncomingPhoneNumber resource. - SmsFallbackUrl: - type: string - format: uri - description: A URL that Twilio will request if an error occurs requesting - or executing the TwiML defined by SmsUrl. This will be copied - onto the IncomingPhoneNumber resource. - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied - onto the IncomingPhoneNumber resource. - StatusCallbackUrl: - type: string - format: uri - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - StatusCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - SmsApplicationSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - description: Optional. The 34 character sid of the application Twilio - should use to handle SMS messages sent to this number. If a `SmsApplicationSid` - is present, Twilio will ignore all of the SMS urls above and use - those set on the application. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - Email: - type: string - description: Optional. Email of the owner of this phone number that - is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - required: - - PhoneNumber - - SmsCapability - /marketplace/AvailableAddOns/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - dependentProperties: - extensions: - mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions - get: - description: Fetch an instance of an Add-on currently available to be installed. + delete: + description: Delete a specific Sync List Permission. + tags: + - PreviewSyncSyncListPermission + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncListPermission + x-maturity: + - Preview + post: + description: Update an identity's access to a specific Sync List. tags: - - PreviewMarketplaceAvailableAddOn + - PreviewSyncSyncListPermission parameters: - - name: Sid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource to fetch. + description: The unique SID identifier of the Sync Service Instance. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. + schema: + type: string required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOn + operationId: UpdateSyncSyncListPermission x-maturity: - Preview - /marketplace/AvailableAddOns: + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncListPermissionRequest + properties: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync List. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync List. + required: + - Read + - Write + - Manage + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - dependentProperties: - extensions: - mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions get: - description: Retrieve a list of Add-ons currently available to be installed. + description: Retrieve a list of all Permissions applying to a Sync List. tags: - - PreviewMarketplaceAvailableAddOn + - PreviewSyncSyncListPermission parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -3779,12 +6360,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceAvailableAddOnResponse + title: ListSyncSyncListPermissionResponse properties: - available_add_ons: + permissions: type: array items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' meta: type: object properties: @@ -3811,139 +6392,90 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOn + operationId: ListSyncSyncListPermission x-maturity: - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: + /Sync/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension + dependentProperties: + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps get: - description: Fetch an instance of an Extension for the Available Add-on. + description: '' tags: - - PreviewMarketplaceAvailableAddOnExtension + - PreviewSyncSyncMap parameters: - - name: AvailableAddOnSid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource with the extension to - fetch. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: The SID of the AvailableAddOn Extension resource to fetch. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.sync.service.sync_map' description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOnExtension + operationId: FetchSyncSyncMap x-maturity: - Preview - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension - get: - description: Retrieve a list of Extensions for the Available Add-on. + delete: + description: '' tags: - - PreviewMarketplaceAvailableAddOnExtension + - PreviewSyncSyncMap parameters: - - name: AvailableAddOnSid + - name: ServiceSid in: path - description: The SID of the AvailableAddOn resource with the extensions to - read. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. + - name: Sid + in: path + description: '' schema: type: string + required: true responses: - '200': - content: - application/json: - schema: - type: object - title: ListMarketplaceAvailableAddOnExtensionResponse - properties: - extensions: - type: array - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOnExtension + operationId: DeleteSyncSyncMap x-maturity: - Preview - /marketplace/InstalledAddOns: + /Sync/Services/{ServiceSid}/Maps: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -3951,61 +6483,68 @@ paths: defaultOutputProperties: [] pathType: list dependentProperties: - extensions: + sync_map_items: mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps post: - description: Install an Add-on for the Account specified. + description: '' tags: - - PreviewMarketplaceInstalledAddOn + - PreviewSyncSyncMap + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.sync.service.sync_map' description: Created security: - accountSid_authToken: [] - operationId: CreateMarketplaceInstalledAddOn + operationId: CreateSyncSyncMap x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: - type: object - title: CreateMarketplaceInstalledAddOnRequest - properties: - AvailableAddOnSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - description: The SID of the AvaliableAddOn to install. - AcceptTermsOfService: - type: boolean - description: Whether the Terms of Service were accepted. - Configuration: - description: The JSON object that represents the configuration of - the new Add-on being installed. + type: object + title: CreateSyncSyncMapRequest + properties: UniqueName: type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - required: - - AvailableAddOnSid - - AcceptTermsOfService + description: '' get: - description: Retrieve a list of Add-ons currently installed on this Account. + description: '' tags: - - PreviewMarketplaceInstalledAddOn + - PreviewSyncSyncMap parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4031,12 +6570,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnResponse + title: ListSyncSyncMapResponse properties: - installed_add_ons: + maps: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.sync.service.sync_map' meta: type: object properties: @@ -4063,193 +6602,188 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOn + operationId: ListSyncSyncMap x-maturity: - Preview - /marketplace/InstalledAddOns/{Sid}: + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - extensions: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage - delete: - description: Remove an Add-on installation from your account + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + get: + description: '' tags: - - PreviewMarketplaceInstalledAddOn + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid in: path - description: The SID of the InstalledAddOn resource to delete. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteMarketplaceInstalledAddOn - x-maturity: - - Preview - get: - description: Fetch an instance of an Add-on currently installed on this Account. - tags: - - PreviewMarketplaceInstalledAddOn - parameters: - - name: Sid + - name: MapSid in: path - description: The SID of the InstalledAddOn resource to fetch. + description: '' + schema: + type: string + required: true + - name: Key + in: path + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOn + operationId: FetchSyncSyncMapItem x-maturity: - Preview - post: - description: Update an Add-on installation for the Account specified. + delete: + description: '' tags: - - PreviewMarketplaceInstalledAddOn + - PreviewSyncSyncMapItem parameters: - - name: Sid + - name: ServiceSid in: path - description: The SID of the InstalledAddOn resource to update. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key + in: path + description: '' + schema: + type: string required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOn + operationId: DeleteSyncSyncMapItem x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateMarketplaceInstalledAddOnRequest - properties: - Configuration: - description: Valid JSON object that conform to the configuration - schema exposed by the associated AvailableAddOn resource. This - is only required by Add-ons that need to be configured - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension - get: - description: Fetch an instance of an Extension for the Installed Add-on. + post: + description: '' tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewSyncSyncMapItem parameters: - - name: InstalledAddOnSid + - name: ServiceSid in: path - description: The SID of the InstalledAddOn resource with the extension to - fetch. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: The SID of the InstalledAddOn Extension resource to fetch. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ required: true + - name: Key + in: path + description: '' + schema: + type: string + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOnExtension + operationId: UpdateSyncSyncMapItem x-maturity: - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapItemRequest + properties: + Data: + description: '' + required: + - Data + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items post: - description: Update an Extension for an Add-on installation. + description: '' tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewSyncSyncMapItem parameters: - - name: InstalledAddOnSid + - name: ServiceSid in: path - description: The SID of the InstalledAddOn resource with the extension to - update. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: The SID of the InstalledAddOn Extension resource to update. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' - description: OK + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + description: Created security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOnExtension + operationId: CreateSyncSyncMapItem x-maturity: - Preview requestBody: @@ -4257,37 +6791,53 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnExtensionRequest + title: CreateSyncSyncMapItemRequest properties: - Enabled: - type: boolean - description: Whether the Extension should be invoked. + Key: + type: string + description: '' + Data: + description: '' required: - - Enabled - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension + - Key + - Data get: - description: Retrieve a list of Extensions for the Installed Add-on. + description: '' tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewSyncSyncMapItem parameters: - - name: InstalledAddOnSid + - name: ServiceSid in: path - description: The SID of the InstalledAddOn resource with the extensions to - read. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^XE[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string required: true + - name: Order + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + - name: From + in: query + description: '' + schema: + type: string + - name: Bounds + in: query + description: '' + schema: + type: string + $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4313,12 +6863,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnExtensionResponse + title: ListSyncSyncMapItemResponse properties: - extensions: + items: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' meta: type: object properties: @@ -4345,27 +6895,22 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOnExtension + operationId: ListSyncSyncMapItem x-maturity: - Preview - /Sync/Services/{ServiceSid}/Documents/{Sid}: + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - document_permissions: - mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions get: - description: '' + description: Fetch a specific Sync Map Permission. tags: - - PreviewSyncDocument + - PreviewSyncSyncMapPermission parameters: - name: ServiceSid in: path @@ -4376,9 +6921,16 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: '' + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true @@ -4387,17 +6939,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocument + operationId: FetchSyncSyncMapPermission x-maturity: - Preview delete: - description: '' + description: Delete a specific Sync Map Permission. tags: - - PreviewSyncDocument + - PreviewSyncSyncMapPermission parameters: - name: ServiceSid in: path @@ -4408,9 +6960,16 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: '' + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true @@ -4419,44 +6978,46 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocument + operationId: DeleteSyncSyncMapPermission x-maturity: - Preview post: - description: '' + description: Update an identity's access to a specific Sync Map. tags: - - PreviewSyncDocument + - PreviewSyncSyncMapPermission parameters: - name: ServiceSid in: path - description: '' + description: The unique SID identifier of the Sync Service Instance. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: '' + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header + - name: Identity + in: path + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocument + operationId: UpdateSyncSyncMapPermission x-maturity: - Preview requestBody: @@ -4464,30 +7025,37 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentRequest + title: UpdateSyncSyncMapPermissionRequest properties: - Data: - description: '' + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Map. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Map. required: - - Data - /Sync/Services/{ServiceSid}/Documents: + - Read + - Write + - Manage + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - dependentProperties: - document_permissions: - mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} - post: - description: '' + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions + get: + description: Retrieve a list of all Permissions applying to a Sync Map. tags: - - PreviewSyncDocument + - PreviewSyncSyncMapPermission parameters: - name: ServiceSid in: path @@ -4498,16 +7066,156 @@ paths: maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. + schema: + type: string + required: true + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' - description: Created + type: object + title: ListSyncSyncMapPermissionResponse + properties: + permissions: + type: array + items: + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListSyncSyncMapPermission + x-maturity: + - Preview + /understand/Assistants/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + dependentProperties: + field_types: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/FieldTypes + tasks: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks + model_builds: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/ModelBuilds + queries: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Queries + assistant_fallback_actions: + mapping: + assistant_sid: sid + resource_url: /understandNone + assistant_initiation_actions: + mapping: + assistant_sid: sid + resource_url: /understandNone + dialogues: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Dialogues + style_sheet: + mapping: + assistant_sid: sid + resource_url: /understandNone + get: + description: '' + tags: + - PreviewUnderstandAssistant + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandAssistant + x-maturity: + - Preview + post: + description: '' + tags: + - PreviewUnderstandAssistant + parameters: + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncDocument + operationId: UpdateUnderstandAssistant x-maturity: - Preview requestBody: @@ -4515,27 +7223,104 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncDocumentRequest + title: UpdateUnderstandAssistantRequest properties: + FriendlyName: + type: string + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + LogQueries: + type: boolean + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. UniqueName: type: string - description: '' - Data: - description: '' - get: + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + CallbackUrl: + type: string + format: uri + description: A user-provided URL to send event callbacks to. + CallbackEvents: + type: string + description: Space-separated list of callback events that will trigger + callbacks. + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + delete: description: '' tags: - - PreviewSyncDocument + - PreviewUnderstandAssistant parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandAssistant + x-maturity: + - Preview + /understand/Assistants: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + field_types: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/FieldTypes + tasks: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks + model_builds: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/ModelBuilds + queries: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Queries + assistant_fallback_actions: + mapping: + assistant_sid: sid + resource_url: /understandNone + assistant_initiation_actions: + mapping: + assistant_sid: sid + resource_url: /understandNone + dialogues: + mapping: + assistant_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Dialogues + style_sheet: + mapping: + assistant_sid: sid + resource_url: /understandNone + get: + description: '' + tags: + - PreviewUnderstandAssistant + parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4561,12 +7346,12 @@ paths: application/json: schema: type: object - title: ListSyncDocumentResponse + title: ListUnderstandAssistantResponse properties: - documents: + assistants: type: array items: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.understand.assistant' meta: type: object properties: @@ -4593,42 +7378,147 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocument + operationId: ListUnderstandAssistant x-maturity: - Preview - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + post: + description: '' + tags: + - PreviewUnderstandAssistant + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandAssistant + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandAssistantRequest + properties: + FriendlyName: + type: string + description: A text description for the Assistant. It is non-unique + and can up to 255 characters long. + LogQueries: + type: boolean + description: A boolean that specifies whether queries should be + logged for 30 days further training. If false, no queries will + be stored, if true, queries will be stored for 30 days and deleted + thereafter. Defaults to true if no value is provided. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + CallbackUrl: + type: string + format: uri + description: A user-provided URL to send event callbacks to. + CallbackEvents: + type: string + description: Space-separated list of callback events that will trigger + callbacks. + FallbackActions: + description: The JSON actions to be executed when the user's input + is not recognized as matching any Task. + InitiationActions: + description: The JSON actions to be executed on inbound phone calls + when the Assistant has to say something first. + StyleSheet: + description: The JSON object that holds the style sheet for the + assistant + /understand/Assistants/{AssistantSid}/FallbackActions: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + parent: /Assistants/{Sid} + mountName: assistant_fallback_actions + className: assistant_fallback_actions get: - description: Fetch a specific Sync Document Permission. + description: '' tags: - - PreviewSyncDocumentPermission + - PreviewUnderstandAssistantFallbackActions parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandAssistantFallbackActions + x-maturity: + - Preview + post: + description: '' + tags: + - PreviewUnderstandAssistantFallbackActions + parameters: + - name: AssistantSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateUnderstandAssistantFallbackActions + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandAssistantFallbackActionsRequest + properties: + FallbackActions: + description: '' + /understand/Assistants/{AssistantSid}/InitiationActions: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{Sid} + mountName: assistant_initiation_actions + className: assistant_initiation_actions + get: + description: '' + tags: + - PreviewUnderstandAssistantInitiationActions + parameters: + - name: AssistantSid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: '' schema: type: string required: true @@ -4637,72 +7527,118 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocumentPermission + operationId: FetchUnderstandAssistantInitiationActions x-maturity: - Preview - delete: - description: Delete a specific Sync Document Permission. + post: + description: '' tags: - - PreviewSyncDocumentPermission + - PreviewUnderstandAssistantInitiationActions parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.assistant_initiation_actions' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateUnderstandAssistantInitiationActions + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandAssistantInitiationActionsRequest + properties: + InitiationActions: + description: '' + /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' + tags: + - PreviewUnderstandDialogue + parameters: + - name: AssistantSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: '' schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: '' schema: type: string required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.dialogue' + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncDocumentPermission + operationId: FetchUnderstandDialogue x-maturity: - Preview - post: - description: Update an identity's access to a specific Sync Document. + /understand/Assistants/{AssistantSid}/Dialogues: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Assistants/{Sid} + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: + description: '' tags: - - PreviewSyncDocumentPermission + - PreviewUnderstandField parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: The unique SID identifier of the Sync Service Instance. + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: TaskSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -4711,62 +7647,66 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.understand.assistant.task.field' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocumentPermission + operationId: FetchUnderstandField x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateSyncDocumentPermissionRequest - properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Document. - Write: - type: boolean - description: Boolean flag specifying whether the identity can update - the Sync Document. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Document. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + delete: + description: '' + tags: + - PreviewUnderstandField + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Field. + schema: + type: string + required: true + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandField + x-maturity: + - Preview + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: - description: Retrieve a list of all Permissions applying to a Sync Document. + description: '' tags: - - PreviewSyncDocumentPermission + - PreviewUnderstandField parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid + - name: TaskSid in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true @@ -4795,12 +7735,12 @@ paths: application/json: schema: type: object - title: ListSyncDocumentPermissionResponse + title: ListUnderstandFieldResponse properties: - permissions: + fields: type: array items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.understand.assistant.task.field' meta: type: object properties: @@ -4827,10 +7767,59 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocumentPermission + operationId: ListUnderstandField x-maturity: - Preview - /Sync/Services/{Sid}: + post: + description: '' + tags: + - PreviewUnderstandField + parameters: + - name: AssistantSid + in: path + description: The unique ID of the parent Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Field. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.field' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandField + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandFieldRequest + properties: + FieldType: + type: string + description: The unique name or sid of the FieldType. It can be + any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) + or the unique_name or the Field Type sid of a custom Field Type. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + required: + - FieldType + - UniqueName + /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -4838,90 +7827,68 @@ paths: defaultOutputProperties: [] pathType: instance dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - sync_lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - sync_maps: + field_values: mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps + assistant_sid: assistant_sid + field_type_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues + parent: /Assistants/{Sid} get: description: '' tags: - - PreviewSyncService + - PreviewUnderstandFieldType parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: Sid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.understand.assistant.field_type' description: OK security: - accountSid_authToken: [] - operationId: FetchSyncService + operationId: FetchUnderstandFieldType x-maturity: - Preview - delete: + post: description: '' tags: - - PreviewSyncService + - PreviewUnderstandFieldType parameters: - - name: Sid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteSyncService - x-maturity: - - Preview - post: - description: '' - tags: - - PreviewSyncService - parameters: - name: Sid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.understand.assistant.field_type' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncService + operationId: UpdateUnderstandFieldType x-maturity: - Preview requestBody: @@ -4929,22 +7896,43 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncServiceRequest + title: UpdateUnderstandFieldTypeRequest properties: - WebhookUrl: - type: string - format: uri - description: '' FriendlyName: type: string - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' - /Sync/Services: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + delete: + description: '' + tags: + - PreviewUnderstandFieldType + parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: '' + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandFieldType + x-maturity: + - Preview + /understand/Assistants/{AssistantSid}/FieldTypes: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' @@ -4952,59 +7940,23 @@ paths: defaultOutputProperties: [] pathType: list dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - sync_lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - sync_maps: + field_values: mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps - post: - description: '' - tags: - - PreviewSyncService - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncService - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncServiceRequest - properties: - FriendlyName: - type: string - description: '' - WebhookUrl: - type: string - format: uri - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' + assistant_sid: assistant_sid + field_type_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues + parent: /Assistants/{Sid} get: description: '' tags: - - PreviewSyncService + - PreviewUnderstandFieldType parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5030,12 +7982,12 @@ paths: application/json: schema: type: object - title: ListSyncServiceResponse + title: ListUnderstandFieldTypeResponse properties: - services: + field_types: type: array items: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.understand.assistant.field_type' meta: type: object properties: @@ -5062,42 +8014,74 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncService + operationId: ListUnderstandFieldType x-maturity: - Preview - /Sync/Services/{ServiceSid}/Lists/{Sid}: + post: + description: '' + tags: + - PreviewUnderstandFieldType + parameters: + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.field_type' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandFieldType + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandFieldTypeRequest + properties: + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + FriendlyName: + type: string + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + required: + - UniqueName + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - sync_list_items: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items - sync_list_permissions: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_lists + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' tags: - - PreviewSyncSyncList + - PreviewUnderstandFieldValue parameters: - - name: ServiceSid + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true + - name: FieldTypeSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -5110,26 +8094,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncList + operationId: FetchUnderstandFieldValue x-maturity: - Preview delete: description: '' tags: - - PreviewSyncSyncList + - PreviewUnderstandFieldValue parameters: - - name: ServiceSid + - name: AssistantSid + in: path + description: '' + schema: + type: string + required: true + - name: FieldTypeSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -5142,79 +8129,39 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncList + operationId: DeleteUnderstandFieldValue x-maturity: - Preview - /Sync/Services/{ServiceSid}/Lists: + /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - dependentProperties: - sync_list_items: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items - sync_list_permissions: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_lists - post: + parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} + get: description: '' tags: - - PreviewSyncSyncList + - PreviewUnderstandFieldValue parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncSyncList - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncListRequest - properties: - UniqueName: - type: string - description: '' - get: - description: '' - tags: - - PreviewSyncSyncList - parameters: - - name: ServiceSid + - name: FieldTypeSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: Language + in: query + description: 'An ISO language-country string of the value. For example: *en-US*' + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5240,12 +8187,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListResponse + title: ListUnderstandFieldValueResponse properties: - lists: + field_values: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' meta: type: object properties: @@ -5272,136 +8219,124 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncList + operationId: ListUnderstandFieldValue x-maturity: - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items - get: + post: description: '' tags: - - PreviewSyncSyncListItem + - PreviewUnderstandFieldValue parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: FieldTypeSid in: path description: '' schema: type: string required: true - - name: Index - in: path - description: '' - schema: - type: integer - required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: OK + $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + description: Created security: - accountSid_authToken: [] - operationId: FetchSyncSyncListItem + operationId: CreateUnderstandFieldValue x-maturity: - Preview - delete: + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandFieldValueRequest + properties: + Language: + type: string + description: An ISO language-country string of the value. + Value: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + SynonymOf: + type: string + description: A value that indicates this field value is a synonym + of. Empty if the value is not a synonym. + required: + - Language + - Value + /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{Sid} + get: description: '' tags: - - PreviewSyncSyncListItem + - PreviewUnderstandModelBuild parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: Sid in: path description: '' schema: type: string required: true - - name: Index - in: path - description: '' - schema: - type: integer - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListItem + operationId: FetchUnderstandModelBuild x-maturity: - Preview post: description: '' tags: - - PreviewSyncSyncListItem + - PreviewUnderstandModelBuild parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: Sid in: path description: '' schema: type: string required: true - - name: Index - in: path - description: '' - schema: - type: integer - required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.understand.assistant.model_build' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListItem + operationId: UpdateUnderstandModelBuild x-maturity: - Preview requestBody: @@ -5409,101 +8344,57 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListItemRequest + title: UpdateUnderstandModelBuildRequest properties: - Data: - description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items - post: + UniqueName: + type: string + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + delete: description: '' tags: - - PreviewSyncSyncListItem + - PreviewUnderstandModelBuild parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid + - name: Sid in: path description: '' schema: type: string required: true responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' - description: Created + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: CreateSyncSyncListItem + operationId: DeleteUnderstandModelBuild x-maturity: - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncListItemRequest - properties: - Data: - description: '' - required: - - Data - get: - description: '' - tags: - - PreviewSyncSyncListItem - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_list_item_enum_query_result_order' - - name: From - in: query - description: '' - schema: - type: string - - name: Bounds - in: query + /understand/Assistants/{AssistantSid}/ModelBuilds: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + parent: /Assistants/{Sid} + get: + description: '' + tags: + - PreviewUnderstandModelBuild + parameters: + - name: AssistantSid + in: path description: '' schema: type: string - $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5529,12 +8420,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListItemResponse + title: ListUnderstandModelBuildResponse properties: - items: + model_builds: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.understand.assistant.model_build' meta: type: object properties: @@ -5561,116 +8452,99 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListItem + operationId: ListUnderstandModelBuild x-maturity: - Preview - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions - get: - description: Fetch a specific Sync List Permission. + post: + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewUnderstandModelBuild parameters: - - name: ServiceSid + - name: AssistantSid in: path description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - description: OK + $ref: '#/components/schemas/preview.understand.assistant.model_build' + description: Created security: - accountSid_authToken: [] - operationId: FetchSyncSyncListPermission + operationId: CreateUnderstandModelBuild x-maturity: - Preview - delete: - description: Delete a specific Sync List Permission. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandModelBuildRequest + properties: + StatusCallback: + type: string + format: uri + description: '' + UniqueName: + type: string + description: 'A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. For example: v0.1' + /understand/Assistants/{AssistantSid}/Queries/{Sid}: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{Sid} + get: + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewUnderstandQuery parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid + - name: AssistantSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: The unique ID of the Assistant. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListPermission + operationId: FetchUnderstandQuery x-maturity: - Preview post: - description: Update an identity's access to a specific Sync List. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewUnderstandQuery parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid + - name: AssistantSid in: path - description: Identifier of the Sync List. Either a SID or a unique name. + description: The unique ID of the parent Assistant. schema: type: string required: true - - name: Identity + - name: Sid in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true @@ -5679,11 +8553,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.understand.assistant.query' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListPermission + operationId: UpdateUnderstandQuery x-maturity: - Preview requestBody: @@ -5691,53 +8565,79 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListPermissionRequest + title: UpdateUnderstandQueryRequest properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync List. - Write: - type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync List. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync List. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + SampleSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + description: An optional reference to the Sample created from this + query. + Status: + type: string + description: 'A string that described the query status. The values + can be: pending_review, reviewed, discarded' + delete: + description: '' + tags: + - PreviewUnderstandQuery + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandQuery + x-maturity: + - Preview + /understand/Assistants/{AssistantSid}/Queries: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions + parent: /Assistants/{Sid} get: - description: Retrieve a list of all Permissions applying to a Sync List. + description: '' tags: - - PreviewSyncSyncListPermission + - PreviewUnderstandQuery parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the parent Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. + - name: Language + in: query + description: An ISO language-country string of the sample. + schema: + type: string + - name: ModelBuild + in: query + description: The Model Build Sid or unique name of the Model Build to be queried. + schema: + type: string + - name: Status + in: query + description: 'A string that described the query status. The values can be: + pending_review, reviewed, discarded' schema: type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5763,12 +8663,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListPermissionResponse + title: ListUnderstandQueryResponse properties: - permissions: + queries: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.understand.assistant.query' meta: type: object properties: @@ -5795,159 +8695,231 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListPermission + operationId: ListUnderstandQuery x-maturity: - Preview - /Sync/Services/{ServiceSid}/Maps/{Sid}: + post: + description: '' + tags: + - PreviewUnderstandQuery + parameters: + - name: AssistantSid + in: path + description: The unique ID of the parent Assistant. + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.query' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateUnderstandQuery + x-maturity: + - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandQueryRequest + properties: + Language: + type: string + description: An ISO language-country string of the sample. + Query: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. It can be up to 2048 characters + long. + Tasks: + type: string + description: Constraints the query to a set of tasks. Useful when + you need to constrain the paths the user can take. Tasks should + be comma separated *task-unique-name-1*, *task-unique-name-2* + ModelBuild: + type: string + description: The Model Build Sid or unique name of the Model Build + to be queried. + Field: + type: string + description: Constraints the query to a given Field with an task. + Useful when you know the Field you are expecting. It accepts one + field in the format *task-unique-name-1*:*field-unique-name* + required: + - Language + - Query + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: instance - dependentProperties: - sync_map_items: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items - sync_map_permissions: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_maps + parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - - PreviewSyncSyncMap + - PreviewUnderstandSample + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Sample. + schema: + type: string + required: true + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandSample + x-maturity: + - Preview + post: + description: '' + tags: + - PreviewUnderstandSample parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Sample. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.understand.assistant.task.sample' description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap + operationId: UpdateUnderstandSample x-maturity: - Preview + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUnderstandSampleRequest + properties: + Language: + type: string + description: An ISO language-country string of the sample. + TaggedText: + type: string + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + SourceChannel: + type: string + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' delete: description: '' tags: - - PreviewSyncSyncMap + - PreviewUnderstandSample parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: TaskSid + in: path + description: The unique ID of the Task associated with this Sample. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMap + operationId: DeleteUnderstandSample x-maturity: - Preview - /Sync/Services/{ServiceSid}/Maps: + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] pathType: list - dependentProperties: - sync_map_items: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items - sync_map_permissions: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_maps - post: + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + get: description: '' tags: - - PreviewSyncSyncMap + - PreviewUnderstandSample parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncSyncMap - x-maturity: - - Preview - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncMapRequest - properties: - UniqueName: - type: string - description: '' - get: - description: '' - tags: - - PreviewSyncSyncMap - parameters: - - name: ServiceSid + - name: TaskSid in: path - description: '' + description: The unique ID of the Task associated with this Sample. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true + - name: Language + in: query + description: An ISO language-country string of the sample. + schema: + type: string - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5973,12 +8945,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapResponse + title: ListUnderstandSampleResponse properties: - maps: + samples: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.understand.assistant.task.sample' meta: type: object properties: @@ -6005,136 +8977,113 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMap + operationId: ListUnderstandSample x-maturity: - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items - get: + post: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewUnderstandSample parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string required: true - - name: Key + - name: TaskSid in: path - description: '' + description: The unique ID of the Task associated with this Sample. schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: OK + $ref: '#/components/schemas/preview.understand.assistant.task.sample' + description: Created security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem + operationId: CreateUnderstandSample x-maturity: - Preview - delete: - description: '' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandSampleRequest + properties: + Language: + type: string + description: An ISO language-country string of the sample. + TaggedText: + type: string + description: The text example of how end-users may express this + task. The sample may contain Field tag blocks. + SourceChannel: + type: string + description: 'The communication channel the sample was captured. + It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, + or *slack*. If not included the value will be null' + required: + - Language + - TaggedText + /understand/Assistants/{AssistantSid}/StyleSheet: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{Sid} + get: + description: Returns Style sheet JSON object for this Assistant tags: - - PreviewSyncSyncMapItem + - PreviewUnderstandStyleSheet parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string - required: true - - name: Key + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapItem + operationId: FetchUnderstandStyleSheet x-maturity: - Preview post: - description: '' + description: Updates the style sheet for an assistant identified by {AssistantSid} + or {AssistantUniqueName}. tags: - - PreviewSyncSyncMapItem + - PreviewUnderstandStyleSheet parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string - required: true - - name: Key + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.understand.assistant.style_sheet' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapItem + operationId: UpdateUnderstandStyleSheet x-maturity: - Preview requestBody: @@ -6142,51 +9091,95 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapItemRequest + title: UpdateUnderstandStyleSheetRequest properties: - Data: - description: '' - required: - - Data - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + StyleSheet: + description: The JSON Style sheet string + /understand/Assistants/{AssistantSid}/Tasks/{Sid}: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] - pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items + pathType: instance + dependentProperties: + fields: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields + samples: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples + task_actions: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understandNone + statistics: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understandNone + parent: /Assistants/{Sid} + get: + description: '' + tags: + - PreviewUnderstandTask + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. + schema: + type: string + required: true + - name: Sid + in: path + description: A 34 character string that uniquely identifies this resource. + schema: + type: string + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchUnderstandTask + x-maturity: + - Preview post: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewUnderstandTask parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' - description: Created + $ref: '#/components/schemas/preview.understand.assistant.task' + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncSyncMapItem + operationId: UpdateUnderstandTask x-maturity: - Preview requestBody: @@ -6194,53 +9187,90 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapItemRequest + title: UpdateUnderstandTaskRequest properties: - Key: + FriendlyName: type: string - description: '' - Data: - description: '' - required: - - Key - - Data - get: + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + ActionsUrl: + type: string + format: uri + description: User-provided HTTP endpoint where from the assistant + fetches actions + delete: description: '' tags: - - PreviewSyncSyncMapItem + - PreviewUnderstandTask parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_result_order' - - name: From - in: query - description: '' - schema: - type: string - - name: Bounds - in: query - description: '' + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteUnderstandTask + x-maturity: + - Preview + /understand/Assistants/{AssistantSid}/Tasks: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: list + dependentProperties: + fields: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields + samples: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples + task_actions: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understandNone + statistics: + mapping: + assistant_sid: assistant_sid + task_sid: sid + resource_url: /understandNone + parent: /Assistants/{Sid} + get: + description: '' + tags: + - PreviewUnderstandTask + parameters: + - name: AssistantSid + in: path + description: The unique ID of the Assistant. schema: type: string - $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6266,12 +9296,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapItemResponse + title: ListUnderstandTaskResponse properties: - items: + tasks: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.understand.assistant.task' meta: type: object properties: @@ -6298,116 +9328,111 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapItem + operationId: ListUnderstandTask x-maturity: - Preview - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: - servers: - - url: https://preview.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: [] - pathType: instance - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions - get: - description: Fetch a specific Sync Map Permission. + post: + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewUnderstandTask parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: AssistantSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: The unique ID of the Assistant. schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - description: OK + $ref: '#/components/schemas/preview.understand.assistant.task' + description: Created security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapPermission + operationId: CreateUnderstandTask x-maturity: - Preview - delete: - description: Delete a specific Sync Map Permission. + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateUnderstandTaskRequest + properties: + UniqueName: + type: string + description: A user-provided string that uniquely identifies this + resource as an alternative to the sid. Unique up to 64 characters + long. + FriendlyName: + type: string + description: A user-provided string that identifies this resource. + It is non-unique and can up to 255 characters long. + Actions: + description: A user-provided JSON object encoded as a string to + specify the actions for this task. It is optional and non-unique. + ActionsUrl: + type: string + format: uri + description: User-provided HTTP endpoint where from the assistant + fetches actions + required: + - UniqueName + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: + servers: + - url: https://preview.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: [] + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + mountName: task_actions + className: task_actions + get: + description: Returns JSON actions for this Task. tags: - - PreviewSyncSyncMapPermission + - PreviewUnderstandTaskActions parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: AssistantSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the parent Assistant. schema: type: string required: true - - name: Identity + - name: TaskSid in: path - description: Arbitrary string identifier representing a user associated with - an FPA token, assigned by the developer. + description: The unique ID of the Task. schema: type: string required: true responses: - '204': - description: The resource was deleted successfully. + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapPermission + operationId: FetchUnderstandTaskActions x-maturity: - Preview post: - description: Update an identity's access to a specific Sync Map. + description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. tags: - - PreviewSyncSyncMapPermission + - PreviewUnderstandTaskActions parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid + - name: AssistantSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the parent Assistant. schema: type: string required: true - - name: Identity + - name: TaskSid in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. + description: The unique ID of the Task. schema: type: string required: true @@ -6416,11 +9441,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapPermission + operationId: UpdateUnderstandTaskActions x-maturity: - Preview requestBody: @@ -6428,111 +9453,47 @@ paths: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapPermissionRequest + title: UpdateUnderstandTaskActionsRequest properties: - Read: - type: boolean - description: Boolean flag specifying whether the identity can read - the Sync Map. - Write: - type: boolean - description: Boolean flag specifying whether the identity can create, - update and delete Items of the Sync Map. - Manage: - type: boolean - description: Boolean flag specifying whether the identity can delete - the Sync Map. - required: - - Read - - Write - - Manage - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: + Actions: + description: The JSON actions that instruct the Assistant how to + perform this task. + /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: servers: - url: https://preview.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: [] - pathType: list - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions + pathType: instance + parent: /Assistants/{AssistantSid}/Tasks/{Sid} + className: task_statistics get: - description: Retrieve a list of all Permissions applying to a Sync Map. + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewUnderstandTaskStatistics parameters: - - name: ServiceSid + - name: AssistantSid in: path - description: '' + description: The unique ID of the parent Assistant. schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: TaskSid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: The unique ID of the Task associated with this Field. schema: type: string required: true - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string responses: '200': content: application/json: schema: - type: object - title: ListSyncSyncMapPermissionResponse - properties: - permissions: - type: array - items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' - meta: - type: object - properties: - first_page_url: - type: string - format: uri - next_page_url: - type: string - format: uri - nullable: true - page: - type: integer - page_size: - type: integer - previous_page_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - key: - type: string + $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapPermission + operationId: FetchUnderstandTaskStatistics x-maturity: - Preview /wireless/Commands/{Sid}: @@ -7245,6 +10206,20 @@ tags: - name: PreviewSyncSyncMap - name: PreviewSyncSyncMapItem - name: PreviewSyncSyncMapPermission +- name: PreviewUnderstandAssistant +- name: PreviewUnderstandAssistantFallbackActions +- name: PreviewUnderstandAssistantInitiationActions +- name: PreviewUnderstandDialogue +- name: PreviewUnderstandField +- name: PreviewUnderstandFieldType +- name: PreviewUnderstandFieldValue +- name: PreviewUnderstandModelBuild +- name: PreviewUnderstandQuery +- name: PreviewUnderstandSample +- name: PreviewUnderstandStyleSheet +- name: PreviewUnderstandTask +- name: PreviewUnderstandTaskActions +- name: PreviewUnderstandTaskStatistics - name: PreviewWirelessCommand - name: PreviewWirelessRatePlan - name: PreviewWirelessSim diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index 35e15a45..a2ccb771 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -327,7 +327,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Messaging: diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index 8e77cd49..c87c46ed 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -330,7 +330,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Trunking/Countries: diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index c79cf833..6732d5ee 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -41,10 +41,6 @@ components: description: 'A JSON string that includes the message body of message interactions (e.g. `{"body": "hello"}`) or the call duration (when available) of a call (e.g. `{"duration": "5"}`).' - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string $ref: '#/components/schemas/interaction_enum_type' @@ -66,7 +62,7 @@ components: pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) - or [Message](https://www.twilio.com/docs/sms/api/message-resource). + or [Message](https://www.twilio.com/docs/sms/api/message. inbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' @@ -204,10 +200,6 @@ components: nullable: true description: 'A JSON string that includes the message body sent to the participant. (e.g. `{"body": "hello"}`)' - x-twilio: - pii: - handling: sensitive - deleteSla: 30 type: type: string $ref: '#/components/schemas/message_interaction_enum_type' @@ -374,10 +366,6 @@ components: nullable: true description: The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 proxy_identifier: type: string nullable: true @@ -823,7 +811,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: @@ -2526,7 +2514,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ - description: The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) + description: The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service. required: diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index ac7f386f..996ec7cf 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -148,7 +148,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index df10a4dc..beceef6b 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -31,10 +31,6 @@ components: nullable: true description: The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters. - x-twilio: - pii: - handling: standard - deleteSla: 7 date_created: type: string format: date-time @@ -100,10 +96,6 @@ components: slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. - x-twilio: - pii: - handling: standard - deleteSla: 7 visibility: type: string $ref: '#/components/schemas/asset_version_enum_visibility' @@ -219,7 +211,6 @@ components: - node12 - node14 - node16 - - node18 serverless.v1.service.build.build_status: type: object properties: @@ -361,29 +352,17 @@ components: nullable: true description: A user-defined string that uniquely identifies the Environment resource. - x-twilio: - pii: - handling: standard - deleteSla: 7 domain_suffix: type: string nullable: true description: A URL-friendly name that represents the environment and forms part of the domain name. - x-twilio: - pii: - handling: standard - deleteSla: 7 domain_name: type: string nullable: true description: The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix. - x-twilio: - pii: - handling: standard - deleteSla: 7 date_created: type: string format: date-time @@ -440,10 +419,6 @@ components: nullable: true description: The string that you assigned to describe the Function resource. It can be a maximum of 255 characters. - x-twilio: - pii: - handling: standard - deleteSla: 7 date_created: type: string format: date-time @@ -510,10 +485,6 @@ components: with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. - x-twilio: - pii: - handling: standard - deleteSla: 7 visibility: type: string $ref: '#/components/schemas/function_version_enum_visibility' @@ -694,20 +665,12 @@ components: type: string nullable: true description: The string that you assigned to describe the Service resource. - x-twilio: - pii: - handling: standard - deleteSla: 7 unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource. - x-twilio: - pii: - handling: standard - deleteSla: 7 include_credentials: type: boolean nullable: true @@ -784,18 +747,10 @@ components: type: string nullable: true description: A string by which the Variable resource can be referenced. - x-twilio: - pii: - handling: standard - deleteSla: 7 value: type: string nullable: true description: A string that contains the actual value of the Variable. - x-twilio: - pii: - handling: standard - deleteSla: 7 date_created: type: string format: date-time @@ -829,7 +784,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Assets: diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index 75745c61..cb210dcb 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -153,20 +153,12 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. - x-twilio: - pii: - handling: standard - deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -216,10 +208,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 flow_sid: type: string minLength: 34 @@ -282,10 +270,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 transitioned_from: type: string nullable: true @@ -333,10 +317,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 execution_sid: type: string minLength: 34 @@ -463,10 +443,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 transitioned_from: type: string nullable: true @@ -514,10 +490,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 engagement_sid: type: string minLength: 34 @@ -559,7 +531,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Flows/{FlowSid}/Engagements: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 84f7152a..84671b85 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -33,20 +33,12 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. - x-twilio: - pii: - handling: standard - deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -96,10 +88,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 flow_sid: type: string minLength: 34 @@ -162,10 +150,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 transitioned_from: type: string nullable: true @@ -213,10 +197,6 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. - x-twilio: - pii: - handling: standard - deleteSla: 30 execution_sid: type: string minLength: 34 @@ -444,7 +424,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Flows/{FlowSid}/Executions: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 36fc27b5..6ca768d2 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -83,25 +83,20 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) + description: The SID of the [Sim](https://www.twilio.com/docs/iot/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. Can be: `new`, `reserving`, - `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile - Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) + 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 @@ -361,10 +356,6 @@ components: \ in binary encoding. For an IP Command sent from a Super SIM, the payload\ \ should not exceed 1300 bytes. If it is larger than 1300 bytes, there\ \ might be fragmentation on the upstream and the message may appear truncated." - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -606,10 +597,6 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/sim_enum_status' @@ -708,10 +695,6 @@ components: nullable: true description: The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 status: type: string $ref: '#/components/schemas/sms_command_enum_status' @@ -875,7 +858,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Sims/{SimSid}/BillingPeriods: @@ -1036,7 +1019,7 @@ paths: type: string - name: SimSid in: query - description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) + description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records. schema: @@ -2311,10 +2294,6 @@ paths: will always return a list containing zero or one SIMs. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index 94d7bc45..3887d0a6 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -17,10 +17,6 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -57,10 +53,6 @@ components: nullable: true description: An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. - x-twilio: - pii: - handling: sensitive - deleteSla: 7 date_expires: type: string format: date-time @@ -88,10 +80,6 @@ components: is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sync.v1.service.document.document_permission: type: object properties: @@ -124,10 +112,6 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. - x-twilio: - pii: - handling: standard - deleteSla: 30 read: type: boolean nullable: true @@ -174,10 +158,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 7 date_created: type: string format: date-time @@ -253,10 +233,6 @@ components: nullable: true description: An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length. - x-twilio: - pii: - handling: sensitive - deleteSla: 0 sync.v1.service.sync_list: type: object properties: @@ -274,10 +250,6 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -334,10 +306,6 @@ components: description: The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sync.v1.service.sync_list.sync_list_item: type: object properties: @@ -382,10 +350,6 @@ components: nullable: true description: An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. - x-twilio: - pii: - handling: sensitive - deleteSla: 7 date_expires: type: string format: date-time @@ -412,10 +376,6 @@ components: description: The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sync_list_item_enum_query_result_order: type: string enum: @@ -457,10 +417,6 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. - x-twilio: - pii: - handling: standard - deleteSla: 30 read: type: boolean nullable: true @@ -496,10 +452,6 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -556,10 +508,6 @@ components: description: The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sync.v1.service.sync_map.sync_map_item: type: object properties: @@ -567,10 +515,6 @@ components: type: string nullable: true description: The unique, user-defined key for the Map Item. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -607,10 +551,6 @@ components: nullable: true description: An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. - x-twilio: - pii: - handling: sensitive - deleteSla: 7 date_expires: type: string format: date-time @@ -637,10 +577,6 @@ components: description: The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sync_map_item_enum_query_result_order: type: string enum: @@ -682,10 +618,6 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. - x-twilio: - pii: - handling: standard - deleteSla: 30 read: type: boolean nullable: true @@ -721,10 +653,6 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -777,10 +705,6 @@ components: description: The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'. - x-twilio: - pii: - handling: standard - deleteSla: 30 securitySchemes: accountSid_authToken: type: http @@ -796,7 +720,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Documents/{Sid}: @@ -1094,10 +1018,6 @@ paths: Document Permission resource to fetch. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -1136,10 +1056,6 @@ paths: Document Permission resource to delete. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '204': @@ -1174,10 +1090,6 @@ paths: Document Permission resource to update. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -2281,10 +2193,6 @@ paths: Sync List Permission resource to fetch. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -2323,10 +2231,6 @@ paths: Sync List Permission resource to delete. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '204': @@ -2361,10 +2265,6 @@ paths: Sync List Permission resource to update. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -2795,10 +2695,6 @@ paths: description: The `key` value of the Sync Map Item resource to fetch. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -2836,10 +2732,6 @@ paths: description: The `key` value of the Sync Map Item resource to delete. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: If-Match in: header @@ -2881,10 +2773,6 @@ paths: description: 'The `key` value of the Sync Map Item resource to update. ' schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: If-Match in: header @@ -3144,10 +3032,6 @@ paths: Sync Map Permission resource to fetch. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -3187,10 +3071,6 @@ paths: Sync Map Permission resource to delete. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '204': @@ -3226,10 +3106,6 @@ paths: Sync Map Permission resource to update. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index a3fb917b..27157e41 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -180,15 +180,11 @@ components: If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null. - x-twilio: - pii: - handling: sensitive - deleteSla: 30 addons: type: string nullable: true - description: An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) - data for all installed Add-ons. + 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 @@ -397,10 +393,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 max_reserved_workers: type: integer nullable: true @@ -467,7 +459,7 @@ components: enum: - FIFO - LIFO - taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics: + taskrouter.v1.task_queue_bulk_real_time_statistics: type: object properties: account_sid: @@ -489,40 +481,18 @@ components: type: array items: {} nullable: true - description: 'The real-time statistics for each requested TaskQueue SID. - `task_queue_data` returns the following attributes: - - - `task_queue_sid`: The SID of the TaskQueue from which these statistics - were calculated. - - - `total_available_workers`: The total number of Workers available for Tasks - in the TaskQueue. - - - `total_eligible_workers`: The total number of Workers eligible for Tasks - in the TaskQueue, regardless of their Activity state. - - - `total_tasks`: The total number of Tasks. - - - `longest_task_waiting_age`: The age of the longest waiting Task. - - - `longest_task_waiting_sid`: The SID of the longest waiting Task. - - - `tasks_by_status`: The number of Tasks grouped by their current status. - - - `tasks_by_priority`: The number of Tasks grouped by priority. - - - `activity_statistics`: The number of current Workers grouped by Activity. - - ' + description: 'The TaskQueue RealTime Statistics for each requested TaskQueue + SID, represented as an array of TaskQueue results corresponding to the + requested TaskQueue SIDs, each result contains the following attributes: + task_queue_sid: The SID of the TaskQueue from which these statistics were + calculated, total_available_workers: The total number of Workers available + for Tasks in the TaskQueue, total_eligible_workers: The total number of + Workers eligible for Tasks in the TaskQueue, independent of their Activity + state, total_tasks: The total number of Tasks, longest_task_waiting_age: + The age of the longest waiting Task, longest_task_waiting_sid: The SID + of the longest waiting Task, tasks_by_status: The number of Tasks by their + current status, tasks_by_priority: The number of Tasks by priority, activity_statistics: + The number of current Workers by Activity.' task_queue_response_count: type: integer nullable: true @@ -933,10 +903,6 @@ components: actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.' - x-twilio: - pii: - handling: sensitive - deleteSla: 30 available: type: boolean nullable: true @@ -965,10 +931,6 @@ components: nullable: true description: The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace. - x-twilio: - pii: - handling: standard - deleteSla: 30 sid: type: string minLength: 34 @@ -1387,10 +1349,6 @@ components: nullable: true description: The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`. - x-twilio: - pii: - handling: standard - deleteSla: 30 sid: type: string minLength: 34 @@ -1680,10 +1638,6 @@ components: nullable: true description: The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`. - x-twilio: - pii: - handling: standard - deleteSla: 30 multi_task_enabled: type: boolean nullable: true @@ -1937,7 +1891,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}: @@ -2702,8 +2656,8 @@ paths: type: string - name: HasAddons in: query - description: Whether to read Tasks with Add-ons. If `true`, returns only Tasks - with Add-ons. If `false`, returns only Tasks without Add-ons. + description: Whether to read Tasks with addons. If `true`, returns only Tasks + with addons. If `false`, returns only Tasks without addons. schema: type: boolean - name: PageSize @@ -3312,10 +3266,6 @@ paths: description: The `friendly_name` of the TaskQueue resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: EvaluateWorkerAttributes in: query description: The attributes of the Workers to read. Returns the TaskQueues @@ -3476,10 +3426,7 @@ paths: defaultOutputProperties: - account_sid - workspace_sid - - task_queue_data - - task_queue_response_count pathType: list - parent: /Workspaces/{WorkspaceSid}/TaskQueues mountName: bulk_real_time_statistics className: task_queue_bulk_real_time_statistics /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics: @@ -4349,10 +4296,6 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. - JitterBufferSize: - type: string - description: 'The jitter buffer size for conference. Can be: `small`, - `medium`, `large`, `off`.' /v1/Workspaces/{WorkspaceSid}/Workers: servers: - url: https://taskrouter.twilio.com @@ -4428,10 +4371,6 @@ paths: description: The `friendly_name` of the Worker resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: TargetWorkersExpression in: query description: 'Filter by Workers that would match an expression. In addition @@ -5538,10 +5477,6 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. - JitterBufferSize: - type: string - description: 'The jitter buffer size for conference. Can be: `small`, - `medium`, `large`, `off`.' /v1/Workspaces/{WorkspaceSid}/Workers/Statistics: servers: - url: https://taskrouter.twilio.com @@ -5952,10 +5887,6 @@ paths: description: The `friendly_name` of the Workflow resources to read. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6556,10 +6487,6 @@ paths: `Customer Support` or `2014 Election Campaign`. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 8c3af888..9e077edb 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -138,10 +138,6 @@ components: nullable: true description: The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true @@ -219,10 +215,6 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 links: type: object format: uri-map @@ -454,10 +446,6 @@ components: URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information. - x-twilio: - pii: - handling: standard - deleteSla: 30 friendly_name: type: string nullable: true @@ -567,7 +555,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}: diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index 739edb1a..af941d6c 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -23,44 +23,6 @@ components: format: uri nullable: true description: The URL of this resource. - trusthub.v1.compliance_tollfree_inquiry: - type: object - properties: - inquiry_id: - type: string - nullable: true - description: The unique ID used to start an embedded compliance registration - session. - inquiry_session_token: - type: string - nullable: true - description: The session token used to start an embedded compliance registration - session. - registration_id: - type: string - nullable: true - description: The TolfreeId matching the Tollfree Profile that should be - resumed or resubmitted for editing. - url: - type: string - format: uri - nullable: true - description: The URL of this resource. - compliance_tollfree_inquiry_enum_status: - type: string - enum: - - PENDING_REVIEW - - IN_REVIEW - - TWILIO_APPROVED - - TWILIO_REJECTED - compliance_tollfree_inquiry_enum_opt_in_type: - type: string - enum: - - VERBAL - - WEB_FORM - - PAPER_FORM - - VIA_TEXT - - MOBILE_QR_CODE trusthub.v1.customer_profile: type: object properties: @@ -333,10 +295,6 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -455,10 +413,6 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -773,7 +727,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/ComplianceInquiries/Customers/Initialize: @@ -877,132 +831,6 @@ paths: a secondary Customer Profile. required: - PrimaryProfileSid - /v1/ComplianceInquiries/Tollfree/Initialize: - servers: - - url: https://trusthub.twilio.com - description: 'TODO: Resource-level docs' - x-twilio: - defaultOutputProperties: - - inquiry_id - - session_token - - registration_id - pathType: list - mountName: compliance_tollfree_inquiries - className: compliance_tollfree_inquiries - post: - description: Create a new Compliance Tollfree Verification Inquiry for the authenticated - account. This is necessary to start a new embedded session. - tags: - - TrusthubV1ComplianceTollfreeInquiries - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/trusthub.v1.compliance_tollfree_inquiry' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateComplianceTollfreeInquiry - x-maturity: - - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateComplianceTollfreeInquiryRequest - properties: - TollfreePhoneNumber: - type: string - format: phone-number - description: The Tollfree phone number to be verified - NotificationEmail: - type: string - description: The email address to receive the notification about - the verification result. - BusinessName: - type: string - description: The name of the business or organization using the - Tollfree number. - BusinessWebsite: - type: string - description: The website of the business or organization using the - Tollfree number. - UseCaseCategories: - type: array - items: - type: string - description: The category of the use case for the Tollfree Number. - List as many are applicable.. - UseCaseSummary: - type: string - description: Use this to further explain how messaging is used by - the business or organization. - ProductionMessageSample: - type: string - description: An example of message content, i.e. a sample message. - OptInImageUrls: - type: array - items: - type: string - description: Link to an image that shows the opt-in workflow. Multiple - images allowed and must be a publicly hosted URL. - OptInType: - type: string - $ref: '#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type' - description: Describe how a user opts-in to text messages. - MessageVolume: - type: string - description: Estimate monthly volume of messages from the Tollfree - Number. - BusinessStreetAddress: - type: string - description: The address of the business or organization using the - Tollfree number. - BusinessStreetAddress2: - type: string - description: The address of the business or organization using the - Tollfree number. - BusinessCity: - type: string - description: The city of the business or organization using the - Tollfree number. - BusinessStateProvinceRegion: - type: string - description: The state/province/region of the business or organization - using the Tollfree number. - BusinessPostalCode: - type: string - description: The postal code of the business or organization using - the Tollfree number. - BusinessCountry: - type: string - description: The country of the business or organization using the - Tollfree number. - AdditionalInformation: - type: string - description: Additional information to be provided for verification. - BusinessContactFirstName: - type: string - description: The first name of the contact for the business or organization - using the Tollfree number. - BusinessContactLastName: - type: string - description: The last name of the contact for the business or organization - using the Tollfree number. - BusinessContactEmail: - type: string - description: The email address of the contact for the business or - organization using the Tollfree number. - BusinessContactPhone: - type: string - format: phone-number - description: The phone number of the contact for the business or - organization using the Tollfree number. - required: - - TollfreePhoneNumber - - NotificationEmail /v1/CustomerProfiles: servers: - url: https://trusthub.twilio.com @@ -3522,7 +3350,6 @@ servers: - url: https://trusthub.twilio.com tags: - name: TrusthubV1ComplianceInquiries -- name: TrusthubV1ComplianceTollfreeInquiries - name: TrusthubV1CustomerProfiles - name: TrusthubV1CustomerProfilesChannelEndpointAssignment - name: TrusthubV1CustomerProfilesEntityAssignments diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 1b176022..86369f08 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -39,10 +39,6 @@ components: nullable: true description: A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name. - x-twilio: - pii: - handling: standard - deleteSla: 30 token: type: string nullable: true @@ -165,10 +161,6 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 factor_sid: type: string minLength: 34 @@ -217,29 +209,17 @@ components: nullable: true description: Details provided to give context about the Challenge. Intended to be shown to the end user. - x-twilio: - pii: - handling: standard - deleteSla: 30 hidden_details: nullable: true description: 'Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`' - x-twilio: - pii: - handling: standard - deleteSla: 30 metadata: nullable: true description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' - x-twilio: - pii: - handling: standard - deleteSla: 30 factor_type: type: string $ref: '#/components/schemas/challenge_enum_factor_types' @@ -298,10 +278,6 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -378,10 +354,6 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 date_created: type: string format: date-time @@ -418,10 +390,6 @@ components: by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -564,10 +532,6 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 binding: nullable: true description: "Contains the `factor_type` specific secret and metadata.\n\ @@ -618,10 +582,6 @@ components: by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' - x-twilio: - pii: - handling: standard - deleteSla: 30 url: type: string format: uri @@ -688,10 +648,6 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. - x-twilio: - pii: - handling: standard - deleteSla: 30 challenge_sid: type: string minLength: 34 @@ -788,10 +744,6 @@ components: type: string nullable: true description: The phone number in SafeList. - x-twilio: - pii: - handling: standard - deleteSla: 0 url: type: string format: uri @@ -875,11 +827,6 @@ components: maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true - verify_event_subscription_enabled: - type: boolean - nullable: true - description: Whether to allow verifications from the service to reach the - stream-events sinks if configured date_created: type: string format: date-time @@ -934,10 +881,6 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - x-twilio: - pii: - handling: standard - deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_enum_channel' @@ -962,19 +905,11 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. - x-twilio: - pii: - handling: sensitive - deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. - x-twilio: - pii: - handling: sensitive - deleteSla: 1 send_code_attempts: type: array items: {} @@ -1085,7 +1020,7 @@ components: description: An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately - available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing). + 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 @@ -1204,10 +1139,6 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). - x-twilio: - pii: - handling: standard - deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_check_enum_channel' @@ -1229,19 +1160,11 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. - x-twilio: - pii: - handling: sensitive - deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. - x-twilio: - pii: - handling: sensitive - deleteSla: 1 date_created: type: string format: date-time @@ -1413,7 +1336,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/AccessTokens: @@ -1900,10 +1823,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '201': @@ -1985,10 +1904,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: FactorSid in: query @@ -2113,10 +2028,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Sid in: path @@ -2161,10 +2072,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Sid in: path @@ -2398,10 +2305,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '204': @@ -2433,10 +2336,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '200': @@ -2484,10 +2383,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Sid in: path @@ -2528,10 +2423,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Sid in: path @@ -2577,10 +2468,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: Sid in: path @@ -2686,10 +2573,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: PageSize in: query @@ -2773,10 +2656,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true responses: '201': @@ -3244,10 +3123,6 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 required: true - name: ChallengeSid in: path @@ -3622,10 +3497,6 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 0 required: true responses: '200': @@ -3650,10 +3521,6 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 0 required: true responses: '204': @@ -3822,10 +3689,6 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. - VerifyEventSubscriptionEnabled: - type: boolean - description: Whether to allow verifications from the service to - reach the stream-events sinks if configured required: - FriendlyName get: @@ -4107,10 +3970,6 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. - VerifyEventSubscriptionEnabled: - type: boolean - description: Whether to allow verifications from the service to - reach the stream-events sinks if configured /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com @@ -4243,12 +4102,6 @@ paths: allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: `enable`(default) or `disable`. For SMS channel only.' - Tags: - type: string - description: A string containing a JSON map of key value pairs of - tags to be recorded as metadata for the message. The object may - contain up to 10 tags. Keys and values can each be up to 128 characters - in length. required: - To - Channel @@ -4387,10 +4240,6 @@ paths: description: Destination of a verification. It is phone number in E.164 format. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: Country in: query description: Filter used to query Verification Attempts sent to the specified diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 6af4137f..a80446e1 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -71,10 +71,6 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. - x-twilio: - pii: - handling: standard - deleteSla: 30 audio_sources_excluded: type: array items: @@ -86,19 +82,11 @@ components: property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. - x-twilio: - pii: - handling: standard - deleteSla: 30 video_layout: nullable: true description: An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. - x-twilio: - pii: - handling: standard - deleteSla: 30 resolution: type: string nullable: true @@ -238,10 +226,6 @@ components: in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request - x-twilio: - pii: - handling: standard - deleteSla: 30 audio_sources_excluded: type: array items: @@ -254,10 +238,6 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. - x-twilio: - pii: - handling: standard - deleteSla: 30 video_layout: nullable: true description: A JSON object that describes the video layout of the composition @@ -265,10 +245,6 @@ components: the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request - x-twilio: - pii: - handling: standard - deleteSla: 30 resolution: type: string nullable: true @@ -460,10 +436,6 @@ components: nullable: true description: The name that was given to the source track of the recording. If no name is given, the `source_sid` is used. - x-twilio: - pii: - handling: standard - deleteSla: 30 offset: type: integer format: int64 @@ -1291,7 +1263,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Compositions/{Sid}: diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index 059c131b..195f9aaf 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -49,10 +49,6 @@ components: nullable: true description: The URL we call using the `voice_method` when the BYOC Trunk receives a call. - x-twilio: - pii: - handling: standard - deleteSla: 30 voice_method: type: string format: http-method @@ -72,10 +68,6 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. - x-twilio: - pii: - handling: standard - deleteSla: 30 voice_fallback_method: type: string format: http-method @@ -95,10 +87,6 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. - x-twilio: - pii: - handling: standard - deleteSla: 30 status_callback_method: type: string format: http-method @@ -237,10 +225,6 @@ components: nullable: true description: The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported. - x-twilio: - pii: - handling: standard - deleteSla: 30 priority: type: integer nullable: true @@ -448,10 +432,6 @@ components: type: string nullable: true description: An IP address in dotted decimal notation, IPv4 only. - x-twilio: - pii: - handling: standard - deleteSla: 30 cidr_prefix_length: type: integer nullable: true @@ -533,7 +513,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/Archives/{Date}/Calls/{Sid}: diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 12105fde..f3297c04 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -63,10 +63,6 @@ components: description: The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64. - x-twilio: - pii: - handling: standard - deleteSla: 30 command_mode: type: string $ref: '#/components/schemas/command_enum_command_mode' @@ -349,10 +345,6 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 account_sid: type: string minLength: 34 @@ -373,19 +365,11 @@ components: type: string nullable: true description: The string that you assigned to describe the Sim resource. - x-twilio: - pii: - handling: standard - deleteSla: 30 iccid: type: string nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM. - x-twilio: - pii: - handling: standard - deleteSla: 30 e_id: type: string nullable: true @@ -592,7 +576,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.52.1 + version: 1.53.0 openapi: 3.0.1 paths: /v1/UsageRecords: @@ -1527,10 +1511,6 @@ paths: list with a maximum size of 1. schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: RatePlan in: query description: The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/iot/wireless/api/rateplan-resource).