diff --git a/CHANGES.md b/CHANGES.md index 66d18449..8c73cc59 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,65 @@ twilio-oai changelog ==================== +[2024-02-09] Version 2.0.0-rc.15 +-------------------------------- +**Api** +- Updated service base url for connect apps and authorized connect apps APIs **(breaking change)** +- Update documentation to reflect RiskCheck GA +- Added optional parameter `CallToken` for create participant api + +**Events** +- Marked as GA + +**Flex** +- Adding `flex_instance_sid` to Flex Configuration +- Adding `provisioning_status` for Email Manager +- Adding `offline_config` to Flex Configuration + +**Insights** +- add flag to restrict access to unapid customers +- decommission voice-qualitystats-endpoint role + +**Intelligence** +- Add text-generation operator (for example conversation summary) results to existing OperatorResults collection. + +**Lookups** +- Remove `carrier` field from `sms_pumping_risk` and leave `carrier_risk_category` **(breaking change)** +- Remove carrier information from call forwarding package **(breaking change)** + +**Messaging** +- Add update instance endpoints to us_app_to_person api +- Add tollfree edit_allowed and edit_reason fields +- Update Phone Number, Short Code, Alpha Sender, US A2P and Channel Sender documentation +- Add DELETE support to Tollfree Verification resource + +**Numbers** +- Add Get Port In request api + +**Push** +- Migrated to new Push API V4 with Resilient Notification Delivery. + +**Serverless** +- Add node18 as a valid Build runtime + +**Taskrouter** +- Add `jitter_buffer_size` param in update reservation +- Add container attribute to task_queue_bulk_real_time_statistics endpoint +- Remove beta_feature check on task_queue_bulk_real_time_statistics endpoint + +**Trusthub** +- Add optional field NotificationEmail to the POST /v1/ComplianceInquiries/Customers/Initialize API +- Add additional optional fields in compliance_tollfree_inquiry.json +- Rename did to tollfree_phone_number in compliance_tollfree_inquiry.json +- Add new optional field notification_email to compliance_tollfree_inquiry.json + +**Verify** +- `Tags` property added again to Public Docs **(breaking change)** +- Remove `Tags` from Public Docs **(breaking change)** +- Add `VerifyEventSubscriptionEnabled` parameter to service create and update endpoints. +- Add `Tags` optional parameter on Verification creation. +- Update Verify TOTP maturity to GA. + + [2024-01-25] Version 2.0.0-rc.14 -------------------------------- **Oauth** diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index 779ffddc..608d4baf 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -21,7 +21,13 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The promoted Auth Token that must be used to authenticate future API requests." + "description": "The promoted Auth Token that must be used to authenticate future API requests.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -69,7 +75,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -113,7 +125,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "date_created": { "type": "string", @@ -149,7 +167,13 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number in SafeList." + "description": "The phone number in SafeList.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } } } }, @@ -179,7 +203,13 @@ "secondary_auth_token": { "type": "string", "nullable": true, - "description": "The generated secondary Auth Token that can be used to authenticate future API requests." + "description": "The generated secondary Auth Token that can be used to authenticate future API requests.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } }, "url": { "type": "string", @@ -1154,6 +1184,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "examples": { "fetch": { "value": "+18001234567" @@ -1201,6 +1237,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "examples": { "delete": { "value": "+18001234567" @@ -1312,5 +1354,10 @@ { "name": "AccountsV1SecondaryAuthToken" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 4ecf7887..28f16134 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -13,7 +13,13 @@ "auth_token": { "type": "string", "nullable": true, - "description": "The authorization token for this account. This token should be kept a secret, so no sharing." + "description": "The authorization token for this account. This token should be kept a secret, so no sharing.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -30,7 +36,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address." + "description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "owner_account_sid": { "type": "string", @@ -71,7 +83,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Account\")" }, "account_enum_status": { "type": "string", @@ -107,7 +120,13 @@ "customer_name": { "type": "string", "nullable": true, - "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters." + "description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -124,7 +143,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "iso_country": { "type": "string", @@ -135,7 +160,13 @@ "postal_code": { "type": "string", "nullable": true, - "description": "The postal code of the address." + "description": "The postal code of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "region": { "type": "string", @@ -153,7 +184,13 @@ "street": { "type": "string", "nullable": true, - "description": "The number and street address of the address." + "description": "The number and street address of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "uri": { "type": "string", @@ -178,9 +215,16 @@ "street_secondary": { "type": "string", "nullable": true, - "description": "The additional number and street address of the address." + "description": "The additional number and street address of the address.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Address\")" }, "api.v2010.account.application": { "type": "object", @@ -350,7 +394,8 @@ "nullable": true, "description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Application\")" }, "api.v2010.account.authorized_connect_app": { "type": "object", @@ -392,18 +437,6 @@ "nullable": true, "description": "The SID that we assigned to the Connect App." }, - "date_created": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, - "date_updated": { - "type": "string", - "format": "date-time-rfc-2822", - "nullable": true, - "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." - }, "permissions": { "type": "array", "items": { @@ -418,7 +451,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthorizedConnectApp\")" }, "authorized_connect_app_enum_permission": { "type": "string", @@ -458,7 +492,8 @@ "nullable": true, "description": "A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumberCountry\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_local": { "type": "object", @@ -546,7 +581,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Local\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine": { "type": "object", @@ -634,7 +670,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"MachineToMachine\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_mobile": { "type": "object", @@ -722,7 +759,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Mobile\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_national": { "type": "object", @@ -810,7 +848,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"National\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_shared_cost": { "type": "object", @@ -898,7 +937,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SharedCost\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_toll_free": { "type": "object", @@ -986,7 +1026,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"TollFree\")" }, "api.v2010.account.available_phone_number_country.available_phone_number_voip": { "type": "object", @@ -1074,7 +1115,8 @@ "nullable": true, "description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Voip\")" }, "api.v2010.account.balance": { "type": "object", @@ -1097,7 +1139,8 @@ "nullable": true, "description": "The units of currency for the account balance" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Balance\")" }, "api.v2010.account.call": { "type": "object", @@ -1141,22 +1184,46 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`." + "description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "to_formatted": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750)." + "description": "The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "from": { "type": "string", "nullable": true, - "description": "The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`." + "description": "The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "from_formatted": { "type": "string", "nullable": true, - "description": "The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750)." + "description": "The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "phone_number_sid": { "type": "string", @@ -1218,7 +1285,13 @@ "forwarded_from": { "type": "string", "nullable": true, - "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty." + "description": "The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "group_sid": { "type": "string", @@ -1231,7 +1304,13 @@ "caller_name": { "type": "string", "nullable": true, - "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty." + "description": "The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "queue_time": { "type": "string", @@ -1257,7 +1336,8 @@ "nullable": true, "description": "A list of subresources available to this call, identified by their URIs relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Call\")" }, "call_enum_event": { "type": "string", @@ -1293,13 +1373,26 @@ "properties": { "request": { "nullable": true, - "description": "Contains a dictionary representing the request of the call." + "description": "Contains a dictionary representing the request of the call.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "response": { "nullable": true, - "description": "Contains a dictionary representing the call response, including a list of the call events." + "description": "Contains a dictionary representing the call response, including a list of the call events.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Event\")" }, "api.v2010.account.call.call_feedback": { "type": "object", @@ -1346,7 +1439,8 @@ "nullable": true, "description": "A 34 character string that uniquely identifies this resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Feedback\")" }, "call_feedback_enum_issues": { "type": "string", @@ -1446,7 +1540,8 @@ "nullable": true, "description": "The status of the feedback summary can be `queued`, `in-progress`, `completed`, or `failed`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"FeedbackSummary\")" }, "call_feedback_summary_enum_status": { "type": "string", @@ -1553,7 +1648,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notification\")" }, "api.v2010.account.call.call_notification-instance": { "type": "object", @@ -1778,7 +1874,8 @@ "nullable": true, "description": "The recorded track. Can be: `inbound`, `outbound`, or `both`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "call_recording_enum_status": { "type": "string", @@ -1880,7 +1977,8 @@ "nullable": true, "description": "The call SID that caused the conference to end." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Conference\")" }, "conference_enum_status": { "type": "string", @@ -2011,7 +2109,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "conference_recording_enum_status": { "type": "string", @@ -2051,12 +2150,24 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App." + "description": "The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "company_name": { "type": "string", "nullable": true, - "description": "The company name set for the Connect App." + "description": "The company name set for the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "deauthorize_callback_method": { "type": "string", @@ -2076,23 +2187,47 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App." + "description": "The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "description": { "type": "string", "nullable": true, - "description": "The description of the Connect App." + "description": "The description of the Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "homepage_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The public URL where users can obtain more information about this Connect App." + "description": "The public URL where users can obtain more information about this Connect App.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "permissions": { "type": "array", @@ -2116,7 +2251,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ConnectApp\")" }, "connect_app_enum_permission": { "type": "string", @@ -2148,7 +2284,13 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", @@ -2331,7 +2473,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"DependentPhoneNumber\")" }, "dependent_phone_number_enum_address_requirement": { "type": "string", @@ -2419,7 +2562,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -2619,7 +2768,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumber\")" }, "incoming_phone_number_enum_address_requirement": { "type": "string", @@ -2685,7 +2835,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "description": { "type": "string", @@ -2724,7 +2880,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOn\")" }, "api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension": { "type": "object", @@ -2764,7 +2921,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "product_name": { "type": "string", @@ -2786,7 +2949,8 @@ "nullable": true, "description": "Whether the Extension will be invoked." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOnExtension\")" }, "api.v2010.account.incoming_phone_number.incoming_phone_number_local": { "type": "object", @@ -2858,7 +3022,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3058,7 +3228,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Local\")" }, "incoming_phone_number_local_enum_address_requirement": { "type": "string", @@ -3164,7 +3335,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3364,7 +3541,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Mobile\")" }, "incoming_phone_number_mobile_enum_address_requirement": { "type": "string", @@ -3470,7 +3648,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity_sid": { "type": "string", @@ -3670,7 +3854,8 @@ "type": "string", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"TollFree\")" }, "incoming_phone_number_toll_free_enum_address_requirement": { "type": "string", @@ -3720,7 +3905,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -3734,7 +3925,8 @@ "nullable": true, "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Key\")" }, "api.v2010.account.message.media": { "type": "object", @@ -3785,7 +3977,8 @@ "nullable": true, "description": "The URI of this Media resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Media\")" }, "api.v2010.account.queue.member": { "type": "object", @@ -3827,7 +4020,8 @@ "nullable": true, "description": "The SID of the Queue the member is in." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Member\")" }, "api.v2010.account.message": { "type": "object", @@ -3835,7 +4029,13 @@ "body": { "type": "string", "nullable": true, - "description": "The text content of the message" + "description": "The text content of the message", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "num_segments": { "type": "string", @@ -3852,12 +4052,24 @@ "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/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." + "description": "The sender's phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "to": { "type": "string", "nullable": true, - "description": "The 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`)" + "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", @@ -3949,7 +4161,8 @@ "nullable": true, "description": "A list of related resources identified by their URIs relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Message\")" }, "message_enum_status": { "type": "string", @@ -4040,7 +4253,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/sms/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/messaging/guides/send-message-feedback-to-twilio)." }, "date_created": { "type": "string", @@ -4059,7 +4272,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Feedback\")" }, "message_feedback_enum_outcome": { "type": "string", @@ -4082,7 +4296,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -4101,7 +4321,8 @@ "nullable": true, "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"NewKey\")" }, "api.v2010.account.new_signing_key": { "type": "object", @@ -4117,7 +4338,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -4136,7 +4363,8 @@ "nullable": true, "description": "The secret your application uses to sign Access Tokens and to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.**" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"NewSigningKey\")" }, "api.v2010.account.notification": { "type": "object", @@ -4234,7 +4462,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notification\")" }, "api.v2010.account.notification-instance": { "type": "object", @@ -4375,7 +4604,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -4389,14 +4624,21 @@ "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "uri": { "type": "string", "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"OutgoingCallerId\")" }, "api.v2010.account.conference.participant": { "type": "object", @@ -4486,7 +4728,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Participant\")" }, "participant_enum_status": { "type": "string", @@ -4543,7 +4786,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payment\")" }, "payments_enum_payment_method": { "type": "string", @@ -4641,7 +4885,8 @@ "nullable": true, "description": " The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Queue\")" }, "api.v2010.account.recording": { "type": "object", @@ -4759,7 +5004,8 @@ "nullable": true, "description": "The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recording\")" }, "recording_enum_status": { "type": "string", @@ -4858,7 +5104,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AddOnResult\")" }, "recording_add_on_result_enum_status": { "type": "string", @@ -4952,7 +5199,8 @@ "nullable": true, "description": "A list of related resources identified by their relative URIs." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payload\")" }, "api.v2010.account.recording.recording_transcription": { "type": "object", @@ -5023,7 +5271,13 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription." + "description": "The text content of the transcription.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -5035,7 +5289,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcription\")" }, "recording_transcription_enum_status": { "type": "string", @@ -5136,7 +5391,8 @@ "nullable": true, "description": "The URI of this resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ShortCode\")" }, "api.v2010.account.signing_key": { "type": "object", @@ -5162,19 +5418,23 @@ "format": "date-time-rfc-2822", "nullable": true } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SigningKey\")" }, "api.v2010.account.sip": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Sip\")" }, "api.v2010.account.sip.sip_domain.sip_auth": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypes\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypeCalls\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping": { "type": "object", @@ -5202,7 +5462,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5212,7 +5478,8 @@ "nullable": true, "description": "The unique string that that we created to identify the CredentialListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthCallsCredentialListMapping\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping": { "type": "object", @@ -5240,7 +5507,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5250,11 +5523,13 @@ "nullable": true, "description": "The unique string that that we created to identify the IpAccessControlListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthCallsIpAccessControlListMapping\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthTypeRegistrations\")" }, "api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping": { "type": "object", @@ -5282,7 +5557,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sid": { "type": "string", @@ -5292,7 +5573,8 @@ "nullable": true, "description": "The unique string that that we created to identify the CredentialListMapping resource." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthRegistrationsCredentialListMapping\")" }, "api.v2010.account.sip.sip_credential_list.sip_credential": { "type": "object", @@ -5324,7 +5606,13 @@ "username": { "type": "string", "nullable": true, - "description": "The username for this credential." + "description": "The username for this credential.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -5343,7 +5631,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Credential\")" }, "api.v2010.account.sip.sip_credential_list": { "type": "object", @@ -5392,7 +5681,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialList\")" }, "api.v2010.account.sip.sip_domain.sip_credential_list_mapping": { "type": "object", @@ -5443,7 +5733,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialListMapping\")" }, "api.v2010.account.sip.sip_domain": { "type": "object", @@ -5519,7 +5810,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_method": { "type": "string", @@ -5553,13 +5850,25 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application." + "description": "The URL that we call to pass status parameters (such as call ended) to your application.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_url": { "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `voice_method` when the domain receives a call." + "description": "The URL we call using the `voice_method` when the domain receives a call.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "subresource_uris": { "type": "object", @@ -5598,7 +5907,8 @@ "nullable": true, "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Domain\")" }, "api.v2010.account.sip.sip_ip_access_control_list": { "type": "object", @@ -5647,7 +5957,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlList\")" }, "api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping": { "type": "object", @@ -5698,7 +6009,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlListMapping\")" }, "api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address": { "type": "object", @@ -5759,7 +6071,8 @@ "nullable": true, "description": "The URI for this resource, relative to `https://api.twilio.com`" } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAddress\")" }, "api.v2010.account.call.siprec": { "type": "object", @@ -5810,7 +6123,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Siprec\")" }, "siprec_enum_track": { "type": "string", @@ -5901,7 +6215,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Stream\")" }, "stream_enum_track": { "type": "string", @@ -5985,7 +6300,8 @@ "nullable": true, "description": "The temporary username that uniquely identifies a Token." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Token\")" }, "api.v2010.account.transcription": { "type": "object", @@ -6056,7 +6372,13 @@ "transcription_text": { "type": "string", "nullable": true, - "description": "The text content of the transcription." + "description": "The text content of the transcription.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -6068,7 +6390,8 @@ "nullable": true, "description": "The URI of the resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcription\")" }, "transcription_enum_status": { "type": "string", @@ -6080,7 +6403,8 @@ }, "api.v2010.account.usage": { "type": "object", - "properties": {} + "properties": {}, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Usage\")" }, "api.v2010.account.usage.usage_record": { "type": "object", @@ -6168,7 +6492,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Record\")" }, "usage_record_enum_category": { "type": "string", @@ -6510,7 +6835,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AllTime\")" }, "usage_record_all_time_enum_category": { "type": "string", @@ -6852,7 +7178,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Daily\")" }, "usage_record_daily_enum_category": { "type": "string", @@ -7194,7 +7521,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"LastMonth\")" }, "usage_record_last_month_enum_category": { "type": "string", @@ -7536,7 +7864,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Monthly\")" }, "usage_record_monthly_enum_category": { "type": "string", @@ -7878,7 +8207,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ThisMonth\")" }, "usage_record_this_month_enum_category": { "type": "string", @@ -8220,7 +8550,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Today\")" }, "usage_record_today_enum_category": { "type": "string", @@ -8562,7 +8893,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Yearly\")" }, "usage_record_yearly_enum_category": { "type": "string", @@ -8904,7 +9236,8 @@ "nullable": true, "description": "The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Yesterday\")" }, "usage_record_yesterday_enum_category": { "type": "string", @@ -9194,7 +9527,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `callback_method` when the trigger fires." + "description": "The URL we call using the `callback_method` when the trigger fires.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 60 + } + } }, "current_value": { "type": "string", @@ -9265,7 +9604,8 @@ "nullable": true, "description": "The URI of the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource this trigger watches, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Trigger\")" }, "usage_trigger_enum_usage_category": { "type": "string", @@ -9571,7 +9911,8 @@ "nullable": true, "description": "The date that this User Defined Message was created, given in RFC 2822 format." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UserDefinedMessage\")" }, "api.v2010.account.call.user_defined_message_subscription": { "type": "object", @@ -9611,7 +9952,8 @@ "nullable": true, "description": "The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UserDefinedMessageSubscription\")" }, "api.v2010.account.validation_request": { "type": "object", @@ -9635,20 +9977,33 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "validation_code": { "type": "string", "nullable": true, "description": "The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called." } - } + }, + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ValidationRequest\")" } } }, @@ -9933,6 +10288,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "friendly_name" @@ -9996,34 +10357,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -10036,11 +10413,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Account\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Account\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Accounts\")" }, "examples": { "readEmpty": { @@ -10689,6 +11069,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "customer_name" @@ -10705,6 +11091,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -10768,34 +11160,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -10808,11 +11216,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.address" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Address\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Address\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Addresses\")" }, "examples": { "readFull": { @@ -11455,34 +11866,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -11495,11 +11922,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.application" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Application\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Application\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Applications\")" }, "examples": { "readFull": { @@ -11991,8 +12421,6 @@ "connect_app_friendly_name": "aaa", "connect_app_homepage_url": "http://www.google.com", "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", - "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", "permissions": [ "get-all" ], @@ -12083,34 +12511,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -12123,11 +12567,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthorizedConnectApp\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthorizedConnectApp\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AuthorizedConnectApps\")" }, "examples": { "readFull": { @@ -12135,13 +12582,11 @@ "authorized_connect_apps": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "connect_app_company_name": "YOUR OTHER MOM", + "connect_app_company_name": "aaa", "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj", - "connect_app_friendly_name": "YOUR MOM", + "connect_app_friendly_name": "aaa", "connect_app_homepage_url": "http://www.google.com", "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "Tue, 31 Aug 2010 20:36:28 +0000", - "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000", "permissions": [ "get-all" ], @@ -12150,14 +12595,11 @@ ], "end": 0, "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", - "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", - "next_page_uri": null, - "num_pages": 1, + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=2&PageSize=50", "page": 0, "page_size": 50, - "previous_page_uri": null, + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=1&PageSize=50", "start": 0, - "total": 1, "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json" } }, @@ -12166,14 +12608,11 @@ "authorized_connect_apps": [], "end": 0, "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", - "last_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50", "next_page_uri": null, - "num_pages": 1, "page": 0, "page_size": 50, "previous_page_uri": null, "start": 0, - "total": 1, "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json" } } @@ -12314,34 +12753,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -12354,11 +12809,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AvailablePhoneNumberCountry\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AvailablePhoneNumberCountry\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Countries\")" }, "examples": { "readFull": { @@ -12763,34 +13221,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -12803,11 +13277,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Local\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Local\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -13090,34 +13567,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -13130,11 +13623,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"MachineToMachine\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"MachineToMachine\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -13417,34 +13913,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -13457,11 +13969,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -13744,34 +14259,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -13784,11 +14315,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"National\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"National\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -14071,34 +14605,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -14111,11 +14661,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"SharedCost\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"SharedCost\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -14398,34 +14951,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -14438,11 +15007,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -14725,34 +15297,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -14765,11 +15353,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Voip\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Voip\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AvailablePhoneNumbers\")" }, "examples": { "readFull": { @@ -14917,7 +15508,7 @@ "account_sid": "account_sid", "call_sid": "sid" }, - "resource_url": "/2010-04-01None" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Feedback.json" }, "events": { "mapping": { @@ -15416,6 +16007,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, "examples": { "readFullPage1": { "value": "+123456789" @@ -15442,6 +16039,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, "examples": { "readFullPage1": { "value": "+987654321" @@ -15585,34 +16188,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -15625,11 +16244,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.call" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Call\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Call\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Calls\")" }, "examples": { "readFullPage1": { @@ -15908,7 +16530,7 @@ "account_sid": "account_sid", "call_sid": "sid" }, - "resource_url": "/2010-04-01None" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Feedback.json" }, "events": { "mapping": { @@ -16517,34 +17139,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -16557,11 +17195,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.call.call_event" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Event\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Event\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Events\")" }, "examples": { "readFull": { @@ -17324,34 +17965,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -17364,11 +18021,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.call.call_notification" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notifications\")" }, "examples": { "readFull": { @@ -17704,34 +18364,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -17744,11 +18420,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.call.call_recording" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" }, "examples": { "readFull": { @@ -18566,34 +19245,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -18606,11 +19301,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.conference" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Conference\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Conference\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Conferences\")" }, "examples": { "readEmpty": { @@ -19166,34 +19864,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -19206,11 +19920,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" }, "examples": { "readFull": { @@ -19894,34 +20611,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -19934,11 +20667,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.connect_app" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ConnectApp\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ConnectApp\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ConnectApps\")" }, "examples": { "readFull": { @@ -19960,10 +20696,10 @@ ], "end": 0, "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50", - "next_page_uri": null, + "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=2&PageSize=50", "page": 0, "page_size": 50, - "previous_page_uri": null, + "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=1&PageSize=50", "start": 0, "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json" } @@ -20078,34 +20814,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -20118,11 +20870,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.address.dependent_phone_number" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"DependentPhoneNumber\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"DependentPhoneNumber\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"DependentPhoneNumbers\")" }, "examples": { "readFull": { @@ -20733,6 +21488,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -20804,34 +21565,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -20844,11 +21621,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IncomingPhoneNumber\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IncomingPhoneNumber\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" }, "examples": { "readFull": { @@ -21500,34 +22280,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -21540,11 +22336,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOn\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOn\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AssignedAddOns\")" }, "examples": { "readFull": { @@ -21910,34 +22709,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -21950,11 +22765,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOnExtension\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AssignedAddOnExtension\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Extensions\")" }, "examples": { "readFull": { @@ -22066,6 +22884,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -22137,34 +22961,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -22177,11 +23017,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Local\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Local\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" }, "examples": { "readFull": { @@ -22614,6 +23457,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -22685,34 +23534,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -22725,11 +23590,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Mobile\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" }, "examples": { "readFull": { @@ -23162,6 +24030,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -23233,34 +24107,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -23273,11 +24163,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"TollFree\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IncomingPhoneNumbers\")" }, "examples": { "readFull": { @@ -23927,34 +24820,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -23967,11 +24876,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.key" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Key\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Key\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Keys\")" }, "examples": { "readFull": { @@ -24377,34 +25289,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -24417,11 +25345,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.message.media" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Media\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Media\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"MediaList\")" }, "examples": { "readFull": { @@ -24791,34 +25722,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -24831,11 +25778,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.queue.member" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Member\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Member\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"QueueMembers\")" }, "examples": { "readFull": { @@ -24954,20 +25904,20 @@ "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "api_version": "2010-04-01", "body": "Hello! \ud83d\udc4d", - "date_created": "Thu, 30 Jul 2015 20:12:31 +0000", - "date_sent": "Thu, 30 Jul 2015 20:12:33 +0000", - "date_updated": "Thu, 30 Jul 2015 20:12:33 +0000", + "date_created": "Thu, 24 Aug 2023 05:01:45 +0000", + "date_sent": "Thu, 24 Aug 2023 05:01:45 +0000", + "date_updated": "Thu, 24 Aug 2023 05:01:45 +0000", "direction": "outbound-api", "error_code": null, "error_message": null, "from": "+14155552345", - "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "num_media": "0", "num_segments": "1", "price": null, "price_unit": null, + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "sent", + "status": "queued", "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, @@ -24997,11 +25947,11 @@ "price": null, "price_unit": null, "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "sent", + "status": "queued", "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "+14155552345", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25024,11 +25974,11 @@ "price": null, "price_unit": null, "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "sent", + "status": "queued", "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "+14155552345", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25055,7 +26005,7 @@ "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "+14155552345", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25078,11 +26028,11 @@ "price": null, "price_unit": null, "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "scheduled", + "status": "queued", "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "+15558675310", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25105,11 +26055,11 @@ "price": null, "price_unit": null, "sid": "MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "scheduled", + "status": "accepted", "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "+15558675310", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25136,7 +26086,7 @@ "subresource_uris": { "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json" }, - "tags": {}, + "tags": null, "to": "whatsapp:+15558675310", "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json" } @@ -25220,7 +26170,7 @@ }, "ShortenUrls": { "type": "boolean", - "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." + "description": "For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must also be provided." }, "ScheduleType": { "type": "string", @@ -25243,12 +26193,12 @@ "RiskCheck": { "type": "string", "$ref": "#/components/schemas/message_enum_risk_check", - "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." + "description": "For SMS pumping protection feature only: Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request." }, "From": { "type": "string", "format": "phone-number", - "description": "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." + "description": "The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belongs to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service's Sender Pool) or you can provide a specific sender from your Sender Pool." }, "MessagingServiceSid": { "type": "string", @@ -25267,7 +26217,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/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." + "description": "The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types](https://www.twilio.com/docs/messaging/guides/accepted-mime-types) of accepted media. To send more than one image in the message, provide multiple `media_url` parameters in the POST request. You can include up to ten `media_url` parameters per message. [International](https://support.twilio.com/hc/en-us/articles/223179808-Sending-and-receiving-MMS-messages) and [carrier](https://support.twilio.com/hc/en-us/articles/223133707-Is-MMS-supported-for-all-carriers-in-US-and-Canada-) limits apply." }, "ContentSid": { "type": "string", @@ -25293,14 +26243,8 @@ "PersistentAction": [ "mailto:test@example.com" ], - "TransientAction": [ - "reply:Tell me more" - ], "StatusCallback": "https://example.com", "To": "+14155552345", - "Title": "An exciting example", - "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", - "TrafficType": "free", "Tags": "{\"campaign_name\": \"Spring Sale 2022\",\"message_type\": \"cart_abandoned\"}" } }, @@ -25315,14 +26259,8 @@ "PersistentAction": [ "mailto:test@example.com" ], - "TransientAction": [ - "reply:Tell me more" - ], "StatusCallback": "https://example.com", - "To": "+14155552345", - "Title": "An exciting example", - "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", - "TrafficType": "free" + "To": "+14155552345" } }, "createWithMessagingService": { @@ -25336,16 +26274,9 @@ "PersistentAction": [ "mailto:test@example.com" ], - "TransientAction": [ - "reply:Tell me more" - ], "StatusCallback": "https://example.com", "To": "+14155552345", - "Title": "An exciting example", - "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", - "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "ContentVariables": "{\"1\": \"name\",\"2\": \"owl.png\"}", - "TrafficType": "free" + "ContentSid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "createWithQueuedStatus": { @@ -25359,14 +26290,8 @@ "PersistentAction": [ "mailto:test@example.com" ], - "TransientAction": [ - "reply:Tell me more" - ], "StatusCallback": "https://example.com", - "To": "+14155552345", - "Title": "An exciting example", - "RichLinkData": "{\"previewUrl\": \"https://www.apple.com/\",\"imageUrl\": \"https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg\"}", - "TrafficType": "free" + "To": "+14155552345" } }, "createScheduledMessageSms": { @@ -25374,7 +26299,6 @@ "Body": "Hello! \ud83d\udc4d", "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ScheduleType": "fixed", - "SendAt": "2021-11-29T23:50:00Z", "StatusCallback": "https://example.com", "To": "+15558675310" } @@ -25382,10 +26306,11 @@ "createScheduledMessageMms": { "value": { "Body": "Hello! \ud83d\udc4d", - "MediaUrl": "https://example.com", + "MediaUrl": [ + "https://example.com" + ], "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ScheduleType": "fixed", - "SendAt": "2021-11-29T23:50:00Z", "StatusCallback": "https://example.com", "To": "+15558675310" } @@ -25395,9 +26320,8 @@ "Body": "Hello! \ud83d\udc4d", "MessagingServiceSid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ScheduleType": "fixed", - "SendAt": "2021-11-29T23:50:00Z", "StatusCallback": "https://example.com", - "To": "whatsapp:+15558675310" + "To": "94287277+15558675310" } } } @@ -25444,6 +26368,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, "examples": { "readFullPage1": { "value": "+123456789" @@ -25476,6 +26406,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, "examples": { "readFullPage1": { "value": "+987654321" @@ -25551,34 +26487,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -25591,11 +26543,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.message" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Message\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Message\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Messages\")" }, "examples": { "readFullPage1": { @@ -26314,34 +27269,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -26354,11 +27325,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.signing_key" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"SigningKey\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"SigningKey\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"SigningKeys\")" }, "examples": { "readFull": { @@ -26622,34 +27596,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -26662,11 +27652,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.notification" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Notification\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Notifications\")" }, "examples": { "readFull": { @@ -26976,6 +27969,12 @@ "schema": { "type": "string", "format": "phone-number" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -26984,6 +27983,12 @@ "description": "The string that identifies the OutgoingCallerId resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -27023,34 +28028,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -27063,11 +28084,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"OutgoingCallerId\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"OutgoingCallerId\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"OutgoingCallerIds\")" }, "examples": { "readFull": { @@ -28237,6 +29261,10 @@ "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": [ @@ -28259,6 +29287,7 @@ "Record": true, "Trim": "do-not-trim", "TimeLimit": 3600, + "CallToken": "call-token-string", "MachineDetection": "enable", "MachineDetectionTimeout": 15, "MachineDetectionSpeechThreshold": 3000, @@ -28288,6 +29317,7 @@ "Record": true, "Trim": "do-not-trim", "TimeLimit": 3600, + "CallToken": "call-token-string", "MachineDetection": "enable", "MachineDetectionTimeout": 15, "MachineDetectionSpeechThreshold": 3000, @@ -28543,34 +29573,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -28583,11 +29629,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Participant\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Participant\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Participants\")" }, "examples": { "readEmpty": { @@ -29415,34 +30464,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -29455,11 +30520,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.queue" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Queue\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Queue\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Queues\")" }, "examples": { "readFull": { @@ -29991,34 +31059,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -30031,11 +31115,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.recording" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Recording\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Recordings\")" }, "examples": { "readFull": { @@ -30434,34 +31521,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -30474,11 +31577,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AddOnResult\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AddOnResult\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"AddOnResults\")" }, "examples": { "readFull": { @@ -30557,7 +31663,7 @@ "add_on_result_sid": "add_on_result_sid", "payload_sid": "sid" }, - "resource_url": "/2010-04-01None" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", @@ -30745,7 +31851,7 @@ "add_on_result_sid": "add_on_result_sid", "payload_sid": "sid" }, - "resource_url": "/2010-04-01None" + "resource_url": "/2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json" } }, "parent": "/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json", @@ -30830,34 +31936,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -30870,11 +31992,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Payload\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Payload\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Payloads\")" }, "examples": { "readFull": { @@ -31171,34 +32296,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -31211,11 +32352,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcriptions\")" }, "examples": { "readFull": { @@ -31604,34 +32748,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -31644,11 +32804,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.short_code" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ShortCode\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ShortCode\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"ShortCodes\")" }, "examples": { "readFull": { @@ -32128,34 +33291,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -32168,11 +33347,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsCredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsCredentialListMapping\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" }, "examples": { "readEmpty": { @@ -32541,34 +33723,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -32581,11 +33779,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsIpAccessControlListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthCallsIpAccessControlListMapping\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" }, "examples": { "readEmpty": { @@ -32968,34 +34169,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -33008,11 +34225,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AuthRegistrationsCredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AuthRegistrationsCredentialListMapping\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Contents\")" }, "examples": { "readEmpty": { @@ -33291,34 +34511,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -33331,11 +34567,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Credential\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Credential\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Credentials\")" }, "examples": { "readFull": { @@ -33807,34 +35046,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -33847,11 +35102,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialList\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialList\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialLists\")" }, "examples": { "readFull": { @@ -34383,34 +35641,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -34423,11 +35697,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"CredentialListMapping\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"CredentialListMappings\")" }, "examples": { "readFull": { @@ -34720,34 +35997,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -34760,11 +36053,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Domain\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Domain\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Domains\")" }, "examples": { "readFull": { @@ -35465,34 +36761,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -35505,11 +36817,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlList\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlList\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlLists\")" }, "examples": { "readFull": { @@ -36187,34 +37502,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -36227,11 +37558,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlListMapping\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAccessControlListMapping\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAccessControlListMappings\")" }, "examples": { "readFull": { @@ -36367,34 +37701,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -36407,11 +37757,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"IpAddress\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"IpAddress\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"IpAddresses\")" }, "examples": { "readFull": { @@ -39296,34 +40649,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -39336,11 +40705,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.transcription" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Transcription\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"Transcriptions\")" }, "examples": { "readFull": { @@ -39550,34 +40922,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -39590,11 +40978,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Record\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Record\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -39778,34 +41169,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -39818,11 +41225,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"AllTime\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"AllTime\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -40006,34 +41416,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -40046,11 +41472,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Daily\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Daily\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -40234,34 +41663,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -40274,11 +41719,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"LastMonth\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"LastMonth\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -40462,34 +41910,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -40502,11 +41966,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Monthly\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Monthly\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -40690,34 +42157,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -40730,11 +42213,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"ThisMonth\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"ThisMonth\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -40918,34 +42404,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -40958,11 +42460,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Today\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Today\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -41146,34 +42651,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -41186,11 +42707,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Yearly\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Yearly\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -41374,34 +42898,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -41414,11 +42954,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Yesterday\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Yesterday\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageRecords\")" }, "examples": { "readFull": { @@ -41996,34 +43539,50 @@ { "properties": { "end": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"end\")" }, "first_page_uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"firstpageuri\")" }, "next_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"nextpageuri\")" }, "page": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"page\")" }, "page_size": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"pagesize\")" }, "previous_page_uri": { "format": "uri", "nullable": true, - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\") @JsonSerialize(nullsUsing = XmlNullToEmptyStringSerializer.class)", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"previouspageuri\")" }, "start": { - "type": "integer" + "type": "integer", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"start\")" }, "uri": { "format": "uri", - "type": "string" + "type": "string", + "x-field-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")", + "x-getter-extra-annotation": "@JacksonXmlProperty(isAttribute = true, localName = \"uri\")" } }, "type": "object" @@ -42036,11 +43595,14 @@ "type": "array", "items": { "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" - } + }, + "x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Trigger\") @JacksonXmlElementWrapper(useWrapping = false)", + "x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Trigger\")" } } } - ] + ], + "x-class-extra-annotation": "@JacksonXmlRootElement(localName = \"UsageTriggers\")" }, "examples": { "readFull": { @@ -42491,6 +44053,9 @@ { "name": "Api20100401FeedbackSummary" }, + { + "name": "Api20100401HealthCheck" + }, { "name": "Api20100401IncomingPhoneNumber" }, @@ -42623,5 +44188,10 @@ { "name": "Api20100401Yesterday" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_autopilot_v1.json b/spec/json/twilio_autopilot_v1.json deleted file mode 100644 index 202c7bef..00000000 --- a/spec/json/twilio_autopilot_v1.json +++ /dev/null @@ -1,6118 +0,0 @@ -{ - "components": { - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - }, - "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." - } - } - } - } - }, - "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.0.0" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Assistants/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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" - } - }, - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "development_stage": "in-development", - "needs_model_build": false, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", - "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchAssistant" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "development_stage": "in-development", - "needs_model_build": false, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", - "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateAssistant", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "so so friendly", - "UniqueName": "so-so-unique", - "LogQueries": true, - "DevelopmentStage": "in-development", - "CallbackUrl": "https://example.com/callback_url", - "CallbackEvents": "model_build_completed model_build_failed", - "StyleSheet": "{}", - "Defaults": "{}" - } - } - } - } - } - } - }, - "delete": { - "description": "", - "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" - } - }, - "/v1/Assistants": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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" - } - }, - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "assistants": [], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0", - "key": "assistants", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "assistants": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "development_stage": "in-development", - "needs_model_build": false, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", - "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - ], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0", - "key": "assistants", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListAssistant" - }, - "post": { - "description": "", - "tags": [ - "AutopilotV1Assistant" - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.assistant" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "development_stage": "in-development", - "needs_model_build": false, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "style_sheet": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "defaults": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", - "dialogues": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "webhooks": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks" - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateAssistant", - "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." - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "so so friendly", - "UniqueName": "so-so-unique", - "LogQueries": true, - "CallbackUrl": "https://example.com/callback_url", - "CallbackEvents": "model_build_completed model_build_failed", - "StyleSheet": "{}", - "Defaults": "{}" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Defaults": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "parent": "/Assistants/{Sid}", - "className": "defaults", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "data": {}, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDefaults" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults", - "data": {} - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDefaults", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "Defaults": "{}" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Dialogues/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "data" - ], - "parent": "/Assistants/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "data": {} - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDialogue" - } - }, - "/v1/Assistants/{AssistantSid}/Dialogues": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "data" - ], - "parent": "/Assistants/{Sid}", - "pathType": "list" - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "field_type" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchField" - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "field_type" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "fields": [], - "meta": { - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "key": "fields", - "next_page_url": null, - "previous_page_url": null, - "page_size": 50 - } - } - }, - "readFull": { - "value": { - "fields": [ - { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" - } - ], - "meta": { - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "key": "fields", - "next_page_url": null, - "previous_page_url": null, - "page_size": 50 - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListField" - }, - "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" - }, - "examples": { - "create": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateField", - "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" - ] - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "FieldType": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "unique_name": "unique_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" - }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchFieldType" - }, - "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" - }, - "examples": { - "update": { - "value": { - "unique_name": "unique_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" - }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateFieldType", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "UniqueName": "unique_name", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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}", - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "previous_page_url": null, - "page": 0, - "page_size": 50, - "next_page_url": null, - "key": "field_types" - }, - "field_types": [] - } - }, - "readFull": { - "value": { - "meta": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "previous_page_url": null, - "page": 0, - "page_size": 50, - "next_page_url": null, - "key": "field_types" - }, - "field_types": [ - { - "unique_name": "unique_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" - }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListFieldType" - }, - "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" - }, - "examples": { - "create": { - "value": { - "unique_name": "unique_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "field_values": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" - }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateFieldType", - "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" - ] - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "value", - "language" - ], - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": null - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchFieldValue" - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "value", - "language" - ], - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", - "pathType": "list" - }, - "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" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListFieldValueResponse", - "properties": { - "field_values": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "field_values": [], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", - "page_size": 50, - "previous_page_url": null, - "key": "field_values", - "page": 0, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "field_values": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" - } - ], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", - "page_size": 50, - "previous_page_url": null, - "key": "field_values", - "page": 0, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListFieldValue" - }, - "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" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateFieldValue", - "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" - ] - }, - "examples": { - "create": { - "value": { - "Value": "value", - "Language": "language", - "SynonymOf": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "status", - "date_created" - ], - "parent": "/Assistants/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "enqueued", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": null - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchModelBuild" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "completed", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": 100, - "error_code": null - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateModelBuild", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "UniqueName": "unique_name" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/ModelBuilds": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "status", - "date_created" - ], - "parent": "/Assistants/{Sid}", - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "page": 0, - "key": "model_builds", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "next_page_url": null, - "previous_page_url": null, - "page_size": 50 - }, - "model_builds": [] - } - }, - "readFull": { - "value": { - "meta": { - "page": 0, - "key": "model_builds", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "next_page_url": null, - "previous_page_url": null, - "page_size": 50 - }, - "model_builds": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "failed", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": 23001 - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListModelBuild" - }, - "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" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "enqueued", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": null - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateModelBuild", - "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." - } - } - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "StatusCallback": "http://www.example.com" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Queries/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "query", - "status", - "language" - ], - "parent": "/Assistants/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": "name", - "fields": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "voice", - "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchQuery" - }, - "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" - }, - "examples": { - "update": { - "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": "name", - "fields": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "sms", - "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateQuery", - "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`" - } - } - }, - "examples": { - "update": { - "value": { - "Status": "status", - "SampleSid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/Queries": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "query", - "status", - "language" - ], - "parent": "/Assistants/{Sid}", - "pathType": "list" - }, - "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" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, - { - "name": "ModelBuild", - "in": "query", - "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "readFull": { - "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - }, - { - "name": "Status", - "in": "query", - "description": "The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "status" - }, - "readFull": { - "value": "status" - } - } - }, - { - "name": "DialogueSid", - "in": "query", - "description": "The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$" - }, - "examples": { - "readEmpty": { - "value": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "readFull": { - "value": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "queries": [], - "meta": { - "previous_page_url": null, - "next_page_url": null, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page": 0, - "key": "queries", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page_size": 50 - } - } - }, - "readFull": { - "value": { - "queries": [ - { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": "name", - "fields": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": null, - "dialogue_sid": "UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "previous_page_url": null, - "next_page_url": null, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page": 0, - "key": "queries", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page_size": 50 - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListQuery" - }, - "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" - }, - "examples": { - "create": { - "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": "name", - "fields": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "voice", - "dialogue_sid": null - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateQuery", - "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" - ] - }, - "examples": { - "create": { - "value": { - "Language": "language", - "Query": "query", - "Tasks": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", - "ModelBuild": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/v1/Assistants/Restore": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "account_sid", - "sid", - "unique_name", - "friendly_name" - ], - "mountName": "restore_assistant", - "pathType": "list" - }, - "post": { - "description": "", - "tags": [ - "AutopilotV1RestoreAssistant" - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/autopilot.v1.restore_assistant" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "unique_name": "so-so-unique", - "friendly_name": "so so friendly", - "needs_model_build": false, - "latest_model_build_sid": null, - "log_queries": true, - "development_stage": "in-development", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateRestoreAssistant", - "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" - ] - }, - "examples": { - "update": { - "value": { - "Assistant": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "tagged_text", - "language", - "source_channel" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", - "date_updated": "2015-07-30T20:00:00Z", - "source_channel": null - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSample" - }, - "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" - }, - "examples": { - "update": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", - "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "alexa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateSample", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "Language": "language", - "TaggedText": "tagged_text" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "tagged_text", - "language", - "source_channel" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "pathType": "list" - }, - "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" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListSampleResponse", - "properties": { - "samples": { - "type": "array", - "items": { - "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "samples": [], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "previous_page_url": null, - "key": "samples", - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "page": 0, - "page_size": 50 - } - } - }, - "readFull": { - "value": { - "samples": [ - { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", - "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "sms" - } - ], - "meta": { - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "previous_page_url": null, - "key": "samples", - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "page": 0, - "page_size": 50 - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListSample" - }, - "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" - }, - "examples": { - "create": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", - "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "alexa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateSample", - "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" - ] - }, - "examples": { - "create": { - "value": { - "Language": "language", - "TaggedText": "tagged_text", - "SourceChannel": "alexa" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/StyleSheet": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "parent": "/Assistants/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "data": {}, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchStyleSheet" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "data": {} - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateStyleSheet", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateStyleSheetRequest", - "properties": { - "StyleSheet": { - "description": "The JSON string that describes the style sheet object." - } - } - }, - "examples": { - "update": { - "value": { - "StyleSheet": "{}" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTask" - }, - "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" - }, - "examples": { - "update": { - "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateTask", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Actions": "{}", - "ActionsUrl": "https://example.com/actions_url" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/Tasks": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "friendly_name" - ], - "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}", - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "key": "tasks", - "page_size": 50, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "previous_page_url": null - }, - "tasks": [] - } - }, - "readFull": { - "value": { - "meta": { - "key": "tasks", - "page_size": 50, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "previous_page_url": null - }, - "tasks": [ - { - "unique_name": "unique_name", - "links": { - "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListTask" - }, - "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" - }, - "examples": { - "create": { - "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateTask", - "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" - ] - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Actions": "{}", - "ActionsUrl": "https://example.com/actions_url" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "data" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "mountName": "task_actions", - "className": "task_actions", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDdddddddddddddddddddddddddddddddd", - "data": {}, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTaskActions" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDdddddddddddddddddddddddddddddddd", - "data": {}, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateTaskActions", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "Actions": "{\"actions\":[{}]}" - } - } - } - } - } - } - } - }, - "/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "samples_count", - "fields_count" - ], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "samples_count": 0, - "fields_count": 0 - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchTaskStatistics" - } - }, - "/v1/Assistants/{AssistantSid}/Webhooks/{Sid}": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "events", - "wehbook_url", - "webhook_method" - ], - "parent": "/Assistants/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "unique_name": "unique_name", - "events": "ondialogueend", - "webhook_url": "https://example.com/url", - "webhook_method": "POST" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchWebhook" - }, - "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" - }, - "examples": { - "update": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "unique_name": "unique_name", - "events": "ondialogueend", - "webhook_url": "https://example.com/url", - "webhook_method": "POST" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateWebhook", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "UniqueName": "unique_name", - "Events": "ondialogueend", - "WebhookUrl": "https://example.com/url", - "WebhookMethod": "POST" - } - } - } - } - } - } - }, - "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" - } - }, - "/v1/Assistants/{AssistantSid}/Webhooks": { - "servers": [ - { - "url": "https://autopilot.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "sid", - "unique_name", - "events", - "wehbook_url", - "webhook_method" - ], - "parent": "/Assistants/{Sid}", - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "key": "webhooks", - "page_size": 50, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", - "previous_page_url": null - }, - "webhooks": [] - } - }, - "readFull": { - "value": { - "meta": { - "key": "webhooks", - "page_size": 50, - "next_page_url": null, - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", - "page": 0, - "first_page_url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0", - "previous_page_url": null - }, - "webhooks": [ - { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "unique_name": "unique_name", - "events": "ondialogueend", - "webhook_url": "https://example.com/url", - "webhook_method": "POST" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListWebhook" - }, - "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" - }, - "examples": { - "create": { - "value": { - "url": "https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "unique_name": "unique_name", - "events": "ondialogueend", - "webhook_url": "https://example.com/url", - "webhook_method": "POST" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateWebhook", - "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" - ] - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "Events": "ondialogueend", - "WebhookUrl": "https://example.com/url", - "WebhookMethod": "POST" - } - } - } - } - } - } - } - } - }, - "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" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index 6a1cd588..83dd3f6b 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -1185,5 +1185,10 @@ { "name": "BulkexportsV1Job" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index c42f3e27..64a1b72d 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -37,17 +37,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -70,7 +88,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -125,7 +149,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -204,7 +234,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -277,7 +313,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/api/chat/rest/users) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -340,7 +382,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "service_sid": { "type": "string", @@ -386,12 +434,24 @@ "from": { "type": "string", "nullable": true, - "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`." + "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "index": { "type": "integer", @@ -443,7 +503,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -508,7 +574,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -645,12 +717,24 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -663,7 +747,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -2090,6 +2180,12 @@ "type": "string" } }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": [ @@ -2656,6 +2752,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -5785,5 +5887,10 @@ { "name": "ChatV1UserChannel" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index b6655573..2f942c94 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -49,12 +49,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "credential_sid": { "type": "string", @@ -130,17 +142,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -163,7 +193,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -304,7 +340,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -383,7 +425,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -456,7 +504,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -498,7 +552,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } } } }, @@ -531,7 +591,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "service_sid": { "type": "string", @@ -572,7 +638,13 @@ "last_updated_by": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable." + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "was_edited": { "type": "boolean", @@ -582,12 +654,24 @@ "from": { "type": "string", "nullable": true, - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`." + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message." + "description": "The content of the message.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "index": { "type": "integer", @@ -601,7 +685,13 @@ }, "media": { "nullable": true, - "description": "An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An object that describes the Message's media, if the message contains media. The object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -655,7 +745,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -720,7 +816,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -867,12 +969,24 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -885,7 +999,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's User within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -977,12 +1097,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`." + "description": "The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "user_sid": { "type": "string", @@ -1205,6 +1337,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -3496,6 +3634,12 @@ "type": "string" } }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": [ @@ -4112,6 +4256,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -7636,5 +7786,10 @@ { "name": "ChatV2Webhook" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index 78ac063f..7795626a 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -37,17 +37,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -70,7 +88,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`." + "description": "The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "members_count": { "type": "integer", @@ -281,5 +305,10 @@ { "name": "ChatV3Channel" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_content_sdk.json b/spec/json/twilio_content_sdk.json new file mode 100644 index 00000000..a8d22772 --- /dev/null +++ b/spec/json/twilio_content_sdk.json @@ -0,0 +1,1766 @@ +{ + "components": { + "securitySchemes": { + "accountSid_authToken": { + "scheme": "basic", + "type": "http" + } + }, + "schemas": { + "listItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/listItem" + } + }, + "listItem": { + "type": "object", + "additionalProperties": false, + "properties": { + "id": { + "type": "string" + }, + "item": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "id", + "item" + ] + }, + "callToActionActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/callToActionAction" + } + }, + "callToActionActionType": { + "type": "string", + "enum": [ + "URL", + "PHONE_NUMBER" + ] + }, + "callToActionAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/callToActionActionType" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "quickReplyActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quickReplyAction" + } + }, + "quickReplyActionType": { + "type": "string", + "enum": [ + "QUICK_REPLY" + ] + }, + "quickReplyAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/quickReplyActionType" + }, + "title": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "cardActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cardAction" + } + }, + "cardActionType": { + "type": "string", + "enum": [ + "URL", + "PHONE_NUMBER", + "QUICK_REPLY" + ] + }, + "cardAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/cardActionType" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "type", + "title" + ] + }, + "authenticationActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/authenticationAction" + } + }, + "authenticationActionType": { + "type": "string", + "enum": [ + "COPY_CODE" + ] + }, + "authenticationAction": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "$ref": "#/components/schemas/authenticationActionType" + }, + "copy_code_text": { + "type": "string" + } + }, + "required": [ + "type", + "copy_code_text" + ] + }, + "twilioText": { + "type": "object", + "description": "Type containing only plain text-based content", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + } + }, + "required": [ + "body" + ] + }, + "twilioMedia": { + "type": "object", + "description": "twilio/media is used to send file attachments, or to send long text via MMS in the US and Canada. As such, the twilio/media type must contain at least ONE of text or media content.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "media" + ] + }, + "twilioLocation": { + "type": "object", + "description": "twilio/location type contains a location pin and an optional label, which can be used to enhance delivery notifications or connect recipients to physical experiences you offer.", + "nullable": true, + "additionalProperties": false, + "properties": { + "latitude": { + "type": "number" + }, + "longitude": { + "type": "number" + }, + "label": { + "type": "string" + } + }, + "required": [ + "latitude", + "longitude" + ] + }, + "twilioListPicker": { + "type": "object", + "description": "twilio/list-picker includes a menu of up to 10 options, which offers a simple way for users to make a selection.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "button": { + "type": "string" + }, + "items": { + "$ref": "#/components/schemas/listItems" + } + }, + "required": [ + "body", + "button", + "items" + ] + }, + "twilioCallToAction": { + "type": "object", + "description": "twilio/call-to-action buttons let recipients tap to trigger actions such as launching a website or making a phone call.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/callToActionActions" + } + } + }, + "twilioQuickReply": { + "type": "object", + "description": "twilio/quick-reply templates let recipients tap, rather than type, to respond to the message.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/quickReplyActions" + } + }, + "required": [ + "body", + "actions" + ] + }, + "twilioCard": { + "type": "object", + "description": "twilio/card is a structured template which can be used to send a series of related information. It must include a title and at least one additional field.", + "nullable": true, + "additionalProperties": false, + "properties": { + "title": { + "type": "string" + }, + "subtitle": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + }, + "actions": { + "$ref": "#/components/schemas/cardActions" + } + }, + "required": [ + "title" + ] + }, + "whatsappCard": { + "type": "object", + "description": "whatsapp/card is a structured template which can be used to send a series of related information. It must include a body and at least one additional field.", + "nullable": true, + "additionalProperties": false, + "properties": { + "body": { + "type": "string" + }, + "footer": { + "type": "string" + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + }, + "header_text": { + "type": "string" + }, + "actions": { + "$ref": "#/components/schemas/cardActions" + } + }, + "required": [ + "body" + ] + }, + "whatsappAuthentication": { + "type": "object", + "description": "whatsApp/authentication templates let companies deliver WA approved one-time-password button.", + "nullable": true, + "additionalProperties": false, + "properties": { + "add_security_recommendation": { + "type": "boolean" + }, + "code_expiration_minutes": { + "type": "number" + }, + "actions": { + "$ref": "#/components/schemas/authenticationActions" + } + }, + "required": [ + "actions" + ] + }, + "ContentApprovalRequest": { + "type": "object", + "description": "Content approval request body", + "required": [ + "name", + "category" + ], + "properties": { + "name": { + "description": "Name of the template.", + "type": "string" + }, + "category": { + "description": "A WhatsApp recognized template category.", + "type": "string" + } + } + }, + "ContentCreateRequest": { + "type": "object", + "description": "Content creation request body", + "properties": { + "friendly_name": { + "description": "User defined name of the content", + "type": "string" + }, + "variables": { + "description": "Key value pairs of variable name to value", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "language": { + "description": "Language code for the content", + "type": "string" + }, + "types": { + "$ref": "#/components/schemas/types" + } + }, + "required": [ + "language", + "types" + ] + }, + "types": { + "description": "Content types", + "type": "object", + "properties": { + "twilio/text": { + "$ref": "#/components/schemas/twilioText" + }, + "twilio/media": { + "$ref": "#/components/schemas/twilioMedia" + }, + "twilio/location": { + "$ref": "#/components/schemas/twilioLocation" + }, + "twilio/list-picker": { + "$ref": "#/components/schemas/twilioListPicker" + }, + "twilio/call-to-action": { + "$ref": "#/components/schemas/twilioCallToAction" + }, + "twilio/quick-reply": { + "$ref": "#/components/schemas/twilioQuickReply" + }, + "twilio/card": { + "$ref": "#/components/schemas/twilioCard" + }, + "whatsapp/card": { + "$ref": "#/components/schemas/whatsappCard" + }, + "whatsapp/authentication": { + "$ref": "#/components/schemas/whatsappAuthentication" + } + } + }, + "content.v1.content.approval_create": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "category": { + "type": "string", + "nullable": true + }, + "content_type": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "nullable": true + }, + "rejection_reason": { + "type": "string", + "nullable": true + }, + "allow_category_change": { + "type": "boolean", + "nullable": true + } + } + }, + "content.v1.content.approval_fetch": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource." + }, + "whatsapp": { + "nullable": true, + "description": "Contains the whatsapp approval information for the Content resource, with fields such as approval status, rejection reason, and category, amongst others." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + }, + "content.v1.content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true, + "description": "A list of links related to the Content resource, such as approval_fetch and approval_create" + } + } + }, + "content.v1.content_and_approvals": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "approval_requests": { + "nullable": true, + "description": "The submitted information and approval request status of the Content resource." + } + } + }, + "content.v1.legacy_content": { + "type": "object", + "properties": { + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that that we created to identify the Content resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource." + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "A string name used to describe the Content resource. Not visible to the end recipient." + }, + "language": { + "type": "string", + "nullable": true, + "description": "Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in." + }, + "variables": { + "nullable": true, + "description": "Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}." + }, + "types": { + "nullable": true, + "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + }, + "legacy_template_name": { + "type": "string", + "nullable": true, + "description": "The string name of the legacy content template associated with this Content resource, unique across all template names for its account. Only lowercase letters, numbers and underscores are allowed" + }, + "legacy_body": { + "type": "string", + "nullable": true, + "description": "The string body field of the legacy content template associated with this Content resource" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of the resource, relative to `https://content.twilio.com`." + } + } + } + } + }, + "info": { + "title": "Twilio - Content", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.1.0" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Content/{Sid}/ApprovalRequests/whatsapp": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "account_sid", + "whatsapp" + ], + "parent": "/Content/{Sid}", + "mountName": "approval_create", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "Contentv1ApprovalCreate" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContentApprovalRequest" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content.approval_create" + }, + "examples": { + "createApproval": { + "value": { + "name": "tree_fiddy", + "category": "UTILITY", + "content_type": "twilio/location", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateContentApprovalRequest" + } + }, + "/v1/Content/{Sid}/ApprovalRequests": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "An Approval Fetch resource represents the approval status of a Content resource.", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "account_sid", + "whatsapp" + ], + "parent": "/Content/{Sid}", + "mountName": "approval_fetch", + "pathType": "instance" + }, + "get": { + "description": "Fetch a Content resource's approval status by its unique Content Sid", + "tags": [ + "Contentv1ApprovalFetch" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource whose approval information to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content.approval_fetch" + }, + "examples": { + "getApproval": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "whatsapp": { + "type": "whatsapp", + "name": "tree_fiddy", + "category": "UTILITY", + "content_type": "twilio/location", + "status": "approved", + "rejection_reason": "", + "allow_category_change": true + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchApproval" + } + }, + "/v1/Content/{Sid}": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types" + ], + "dependentProperties": { + "approval_create": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests/whatsapp" + }, + "approval_fetch": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests" + } + }, + "mountName": "contents", + "pathType": "instance" + }, + "get": { + "description": "Fetch a Content resource by its unique Content Sid", + "tags": [ + "Contentv1Content" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "fetch": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchContent" + }, + "delete": { + "description": "Deletes a Content resource", + "tags": [ + "Contentv1Content" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The Twilio-provided string that uniquely identifies the Content resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HX[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteContent" + } + }, + "/v1/Content": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types" + ], + "dependentProperties": { + "approval_create": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests/whatsapp" + }, + "approval_fetch": { + "mapping": { + "content_sid": "sid" + }, + "resource_url": "/v1/Content/{content_sid}/ApprovalRequests" + } + }, + "mountName": "contents", + "pathType": "list" + }, + "post": { + "description": "Create a Content resource", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContentCreateRequest" + } + } + } + }, + "tags": [ + "Contentv1Content" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content.v1.content" + }, + "examples": { + "create": { + "value": { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateContent" + }, + "get": { + "description": "Retrieve a list of Contents belonging to the account used to make the request", + "tags": [ + "Contentv1Content" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListContentResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "links": { + "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp", + "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests" + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/Content?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListContent" + } + }, + "/v1/ContentAndApprovals": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Content resource represents rich messaging content and its respective approval request status.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types", + "approval_requests" + ], + "className": "content_and_approvals", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Contents with approval statuses belonging to the account used to make the request", + "tags": [ + "Contentv1ContentAndApprovals" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListContentAndApprovalsResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.content_and_approvals" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "previous_page_url": null, + "next_page_url": null, + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0", + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z", + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "approval_requests": { + "name": "", + "category": "", + "content_type": "", + "status": "unsubmitted", + "rejection_reason": "", + "allow_category_change": true + } + }, + { + "language": "en", + "date_updated": "2023-01-13T23:33:46Z", + "variables": { + "1": "name", + "2": "typedocument" + }, + "friendly_name": "Media Test", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX5fcd48a417c1cb59da349ad6d5da4607", + "date_created": "2023-01-13T23:33:46Z", + "types": { + "twilio/media": { + "body": "{{1}}, Congratulations {{2}}! For additional assistance, please contact us at hello@twilio.com", + "media": [ + "https://example.com/template" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "approved", + "rejection_reason": "", + "name": "Media Test", + "content_type": "twilio/media", + "allow_category_change": false + } + }, + { + "language": "en", + "date_updated": "2023-01-18T02:46:35Z", + "variables": { + "1": "name", + "2": "type_video", + "3": "small.mp4" + }, + "friendly_name": "Video Highlights", + "account_sid": "AC25c0d4b9093547216c460212e24e77ee", + "sid": "HX15c711fcc6d9ea5268d7ab77938a20ff", + "date_created": "2023-01-18T02:46:35Z", + "types": { + "twilio/media": { + "body": "Hi there, {{1}}, we have received your request to upload {{2}}, and should be uploaded shortly.", + "media": [ + "http://example.com/highlights/{{3}}" + ] + } + }, + "approval_requests": { + "category": "TRANSACTIONAL", + "status": "rejected", + "rejection_reason": "INVALID_FORMAT. Facebook is not able to create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff due to the following error: Invalid parameter. More Details: Message template 'components' param is missing expected field(s). component of type HEADER is missing expected field(s) (example)", + "name": "Video Highlights", + "content_type": "twilio/media", + "allow_category_change": true + } + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "url": "https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0", + "previous_page_url": null, + "next_page_url": null, + "key": "contents" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListContentAndApprovals" + } + }, + "/v1/LegacyContent": { + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "description": "A Legacy Content resource represents legacy rich messaging content.", + "x-twilio": { + "defaultOutputProperties": [ + "date_created", + "date_updated", + "sid", + "account_sid", + "friendly_name", + "language", + "variables", + "types", + "legacy_template_name", + "legacy_body" + ], + "mountName": "legacy_contents", + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of Legacy Contents belonging to the account used to make the request", + "tags": [ + "Contentv1LegacyContent" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListLegacyContentResponse", + "properties": { + "contents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content.v1.legacy_content" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "examples": { + "readEmpty": { + "value": { + "contents": [], + "meta": { + "page": 0, + "page_size": 10, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0", + "next_page_url": null, + "key": "contents" + } + } + }, + "readResults": { + "value": { + "contents": [ + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Some content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_1", + "legacy_body": "a body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Anotha content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_2", + "legacy_body": "another body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + }, + { + "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Third content", + "language": "en", + "variables": { + "name": "foo" + }, + "legacy_template_name": "legacy_template_3", + "legacy_body": "a third body", + "types": { + "twilio/text": { + "body": "Foo Bar Co is located at 39.7392, 104.9903" + }, + "twilio/location": { + "longitude": 104.9903, + "latitude": 39.7392, + "label": "Foo Bar Co" + } + }, + "url": "https://content.twilio.com/v1/LegacyContent", + "date_created": "2015-07-30T19:00:00Z", + "date_updated": "2015-07-30T19:00:00Z" + } + ], + "meta": { + "page": 0, + "page_size": 20, + "first_page_url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "previous_page_url": null, + "url": "https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0", + "next_page_url": null, + "key": "contents" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListLegacyContent" + } + } + }, + "servers": [ + { + "url": "https://content.twilio.com" + } + ], + "tags": [ + { + "name": "Contentv1ApprovalCreate" + }, + { + "name": "Contentv1ApprovalFetch" + }, + { + "name": "Contentv1Content" + }, + { + "name": "Contentv1ContentAndApprovals" + }, + { + "name": "Contentv1LegacyContent" + } + ] +} \ No newline at end of file diff --git a/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index 3c1f55ae..4fba59f7 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -85,7 +85,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." }, "url": { "type": "string", @@ -148,7 +148,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." }, "approval_requests": { "nullable": true, @@ -203,7 +203,7 @@ }, "types": { "nullable": true, - "description": "The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) (e.g. twilio/text) for this Content resource." + "description": "The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource." }, "legacy_template_name": { "type": "string", @@ -345,7 +345,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Content/{sid}/ApprovalRequests" } }, "mountName": "contents", @@ -480,7 +480,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Content/{sid}/ApprovalRequests" } }, "mountName": "contents", @@ -1167,5 +1167,10 @@ { "name": "ContentV1LegacyContent" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index b8008cb7..b66473c6 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -85,7 +85,13 @@ "address": { "type": "string", "nullable": true, - "description": "The unique address to be configured. The address can be a whatsapp address or phone number" + "description": "The unique address to be configured. The address can be a whatsapp address or phone number", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -247,17 +253,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "state": { "type": "string", @@ -348,23 +372,47 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`." + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long." + "description": "The content of the message, can be up to 1,600 characters long.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "participant_sid": { "type": "string", @@ -408,7 +456,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." } } }, @@ -548,16 +596,34 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters." + "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -711,7 +777,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this credential, limited to 64 characters. Optional." + "description": "The human-readable name of this credential, limited to 64 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -790,11 +862,23 @@ "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters." + "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_sid": { "type": "string", @@ -807,17 +891,35 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource." + "description": "An application-defined string that uniquely identifies the Conversation resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "conversation_date_created": { "type": "string", @@ -892,7 +994,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -957,7 +1065,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this service, limited to 256 characters. Optional." + "description": "The human-readable name of this service, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -1035,12 +1149,24 @@ "endpoint": { "type": "string", "nullable": true, - "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`." + "description": "The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info." + "description": "The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "binding_type": { "type": "string", @@ -1164,17 +1290,35 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL." + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "state": { "type": "string", @@ -1273,23 +1417,47 @@ "author": { "type": "string", "nullable": true, - "description": "The channel specific identifier of the message's author. Defaults to `system`." + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "body": { "type": "string", "nullable": true, - "description": "The content of the message, can be up to 1,600 characters long." + "description": "The content of the message, can be up to 1,600 characters long.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "media": { "type": "array", "items": {}, "nullable": true, - "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`." + "description": "An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "participant_sid": { "type": "string", @@ -1333,7 +1501,7 @@ "maxLength": 34, "pattern": "^HX[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) template." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template." } } }, @@ -1489,16 +1657,34 @@ "identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters." + "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "role_sid": { "type": "string", @@ -1706,11 +1892,23 @@ "participant_identity": { "type": "string", "nullable": true, - "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters." + "description": "A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "participant_messaging_binding": { "nullable": true, - "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant." + "description": "Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_sid": { "type": "string", @@ -1723,17 +1921,35 @@ "conversation_unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource." + "description": "An application-defined string that uniquely identifies the Conversation resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "conversation_date_created": { "type": "string", @@ -1808,7 +2024,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -1889,17 +2111,35 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -1999,7 +2239,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_state": { "type": "string", @@ -2014,7 +2260,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -2042,7 +2294,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." + "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -2170,17 +2428,35 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "attributes": { "type": "string", "nullable": true, - "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned." + "description": "The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "is_online": { "type": "boolean", @@ -2280,7 +2556,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The human-readable name of this conversation, limited to 256 characters. Optional." + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conversation_state": { "type": "string", @@ -2295,7 +2577,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned." + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -2323,7 +2611,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL." + "description": "An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -4057,7 +4351,7 @@ "conversation_sid": "conversation_sid", "message_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, "parent": "/Conversations/{Sid}", @@ -4301,7 +4595,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-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", @@ -4662,7 +4956,7 @@ "conversation_sid": "conversation_sid", "message_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, "parent": "/Conversations/{Sid}", @@ -7647,7 +7941,7 @@ "mapping": { "chat_service_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{chat_service_sid}/Configuration" }, "participant_conversations": { "mapping": { @@ -7897,7 +8191,7 @@ "mapping": { "chat_service_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{chat_service_sid}/Configuration" }, "participant_conversations": { "mapping": { @@ -8184,6 +8478,12 @@ "items": { "type": "string" } + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -9240,7 +9540,7 @@ "conversation_sid": "conversation_sid", "message_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", @@ -9501,7 +9801,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-api) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." + "description": "The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored." }, "ContentVariables": { "type": "string", @@ -9880,7 +10180,7 @@ "conversation_sid": "conversation_sid", "message_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata" } }, "parent": "/Services/{ChatServiceSid}/Conversations/{Sid}", @@ -15058,5 +15358,10 @@ { "name": "ConversationsV1Webhook" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index c247c928..b53c9bd5 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -229,7 +229,7 @@ "schema_version": { "type": "integer", "nullable": true, - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." }, "subscription_sid": { "type": "string", @@ -1759,7 +1759,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent subscription", + "description": "Event subscribed to in the parent Subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -1922,7 +1922,7 @@ "operationId": "ListSubscribedEvent" }, "post": { - "description": "Create a new Subscribed Event type for the subscription", + "description": "Add an event type to a Subscription.", "tags": [ "EventsV1SubscribedEvent" ], @@ -1982,7 +1982,7 @@ }, "SchemaVersion": { "type": "integer", - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." } }, "required": [ @@ -2008,7 +2008,7 @@ "url": "https://events.twilio.com" } ], - "description": "Event subscribed to in the parent subscription", + "description": "Event subscribed to in the parent Subscription", "x-twilio": { "defaultOutputProperties": [ "type", @@ -2143,7 +2143,7 @@ "properties": { "SchemaVersion": { "type": "integer", - "description": "The schema version that the subscription should use." + "description": "The schema version that the Subscription should use." } } }, @@ -2159,7 +2159,7 @@ } }, "delete": { - "description": "Remove an event type from a subscription.", + "description": "Remove an event type from a Subscription.", "tags": [ "EventsV1SubscribedEvent" ], @@ -2742,5 +2742,10 @@ { "name": "EventsV1Subscription" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index 381544a8..561a4626 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -185,6 +185,14 @@ "nullable": true, "description": "The SID of the Flex service instance." }, + "flex_instance_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex instance." + }, "ui_language": { "type": "string", "nullable": true, @@ -333,6 +341,10 @@ "citrix_voice_vdi": { "nullable": true, "description": "Citrix voice vdi configuration and settings." + }, + "offline_config": { + "nullable": true, + "description": "Presence and presence ttl configuration" } } }, @@ -378,7 +390,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "chat_service_sid": { "type": "string", @@ -600,6 +618,128 @@ } } }, + "flex.v1.insights_conversational_ai": { + "type": "object", + "properties": { + "instance_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "Sid of Flex Service Instance" + }, + "report_id": { + "type": "string", + "nullable": true, + "description": "The type of report required to fetch.Like gauge,channel-metrics,queue-metrics" + }, + "granularity": { + "type": "string", + "$ref": "#/components/schemas/insights_conversational_ai_enum_granularity", + "nullable": true, + "description": "The time period for which report is needed" + }, + "period_start": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The start date from which report data is included" + }, + "period_end": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The end date till report data is included" + }, + "updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Updated time of the report" + }, + "total_pages": { + "type": "integer", + "nullable": true, + "description": "Represents total number of pages fetched report has" + }, + "page": { + "type": "integer", + "nullable": true, + "description": "Page offset required for pagination" + }, + "rows": { + "type": "array", + "items": {}, + "nullable": true, + "description": "List of report breakdown " + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource." + } + } + }, + "insights_conversational_ai_enum_granularity": { + "type": "string", + "enum": [ + "days", + "weeks", + "months", + "quarters", + "years" + ] + }, + "flex.v1.insights_conversational_ai_report_insights": { + "type": "object", + "properties": { + "instance_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The Instance SID of the instance for which report insights is fetched" + }, + "report_id": { + "type": "string", + "nullable": true, + "description": "The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics" + }, + "period_start": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The start date from which report insights data is included" + }, + "period_end": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The end date till report insights data is included" + }, + "updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Updated time of the report insights" + }, + "insights": { + "type": "array", + "items": {}, + "nullable": true, + "description": "List of report insights breakdown" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource" + } + } + }, "flex.v1.insights_conversations": { "type": "object", "properties": { @@ -1034,7 +1174,7 @@ "type": "string", "$ref": "#/components/schemas/interaction_channel_enum_type", "nullable": true, - "description": "The Interaction Channel's type. Can be: `sms`, `email`, `chat`, `whatsapp`, `web`. \n **Note:** These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type" + "description": "The Interaction Channel's type. Can be: `sms`, `email`, `chat`, `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type" }, "status": { "type": "string", @@ -1209,6 +1349,48 @@ "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" + ] + }, + "transfer_enum_transfer_status": { + "type": "string", + "enum": [ + "ACTIVE", + "FAILED", + "COMPLETED" + ] + }, + "transfer_enum_transfer_type": { + "type": "string", + "enum": [ + "WARM", + "COLD", + "EXTERNAL" + ] + }, "flex.v1.web_channel": { "type": "object", "properties": { @@ -1762,6 +1944,7 @@ "messaging_service_instance_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "chat_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "flex_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ui_language": "en", "ui_attributes": {}, "ui_dependencies": {}, @@ -1925,6 +2108,10 @@ }, "citrix_voice_vdi": { "enabled": false + }, + "offline_config": { + "presence": true, + "presence_ttl": 30 } } } @@ -2024,6 +2211,7 @@ "messaging_service_instance_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "chat_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "flex_service_instance_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "flex_instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "ui_language": "en", "ui_attributes": {}, "ui_dependencies": {}, @@ -2167,6 +2355,10 @@ }, "citrix_voice_vdi": { "enabled": false + }, + "offline_config": { + "presence": true, + "presence_ttl": 30 } } } @@ -2213,6 +2405,12 @@ "description": "The `friendly_name` of the Flex Flow resources to read.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -3632,6 +3830,272 @@ "operationId": "ListInsightsAssessmentsComment" } }, + "/v1/Insights/Instances/{InstanceSid}/AI/Reports": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "report_id" + ], + "mountName": "insights_conversational_ai", + "pathType": "instance" + }, + "get": { + "description": "Fetch Account Based Conversational AI Reports", + "tags": [ + "FlexV1InsightsConversationalAi" + ], + "parameters": [ + { + "name": "InstanceSid", + "in": "path", + "description": "Sid of Flex Service Instance", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MaxRows", + "in": "query", + "description": "Maximum number of rows to return", + "schema": { + "type": "integer" + }, + "examples": { + "readReports": { + "value": 10 + } + } + }, + { + "name": "ReportId", + "in": "query", + "description": "The type of report required to fetch.Like gauge,channel-metrics,queue-metrics", + "schema": { + "type": "string" + }, + "examples": { + "readReports": { + "value": "gauge" + } + } + }, + { + "name": "Granularity", + "in": "query", + "description": "The time period for which report is needed", + "schema": { + "type": "string", + "$ref": "#/components/schemas/insights_conversational_ai_enum_granularity" + }, + "examples": { + "readReports": { + "value": "days" + } + } + }, + { + "name": "IncludeDate", + "in": "query", + "description": "A reference date that should be included in the returned period", + "schema": { + "type": "string", + "format": "date-time" + }, + "examples": { + "readReports": { + "value": "2015-07-30T20:00:00Z" + } + } + }, + { + "name": "Page", + "in": "query", + "description": "Page offset required for pagination", + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_conversational_ai" + }, + "examples": { + "readReports": { + "value": { + "instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "report_id": "gauge", + "granularity": "days", + "period_start": "2015-07-30T20:00:00Z", + "period_end": "2015-07-30T20:00:00Z", + "updated": "2015-07-30T20:00:00Z", + "total_pages": 1, + "page": 1, + "rows": [ + {} + ], + "url": "https://flex-api.twilio.com/v1/Insights/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AI/Reports" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsConversationalAi" + } + }, + "/v1/Insights/Instances/{InstanceSid}/AI/ReportInsights": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "report_id" + ], + "mountName": "insights_conversational_ai_report_insights", + "className": "insights_conversational_ai_report_insights", + "pathType": "instance" + }, + "get": { + "description": "Fetch Instance Based Conversational AI Report Insights", + "tags": [ + "FlexV1InsightsConversationalAiReportInsights" + ], + "parameters": [ + { + "name": "InstanceSid", + "in": "path", + "description": "The Instance SID of the instance for which report insights will be fetched", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MaxRows", + "in": "query", + "description": "Maximum number of rows to return", + "schema": { + "type": "integer" + }, + "examples": { + "readReportinsights": { + "value": 10 + } + } + }, + { + "name": "ReportId", + "in": "query", + "description": "The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics", + "schema": { + "type": "string" + }, + "examples": { + "readReportinsights": { + "value": "gauges" + } + } + }, + { + "name": "Granularity", + "in": "query", + "description": "The time period for which report insights is needed", + "schema": { + "type": "string" + }, + "examples": { + "readReportinsights": { + "value": "days" + } + } + }, + { + "name": "IncludeDate", + "in": "query", + "description": "A reference date that should be included in the returned period", + "schema": { + "type": "string", + "format": "date-time" + }, + "examples": { + "readReportinsights": { + "value": "2015-07-30T20:00:00Z" + } + } + }, + { + "name": "Page", + "in": "query", + "description": "Page offset required for pagination", + "schema": { + "type": "integer" + }, + "examples": { + "readReportinsights": { + "value": 1 + } + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_conversational_ai_report_insights" + }, + "examples": { + "readReportinsights": { + "value": { + "instance_sid": "GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "report_id": "gauges", + "period_start": "2015-07-30T20:00:00Z", + "period_end": "2015-07-30T20:00:00Z", + "updated": "2015-07-30T20:00:00Z", + "insights": [], + "url": "https://flex-api.twilio.com/v1/Insights/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AI/ReportInsights" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsConversationalAiReportInsights" + } + }, "/v1/Insights/Conversations": { "servers": [ { @@ -7374,6 +7838,53 @@ } } }, + "/v1/account/provision/status": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Status for email provisioning", + "x-twilio": { + "defaultOutputProperties": [ + "status" + ], + "mountName": "provisioning_status", + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ProvisioningStatus" + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.provisioning_status" + }, + "examples": { + "fetch": { + "value": { + "status": "active", + "url": "https://flex-api.twilio.com/v1/account/provision/status" + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchProvisioningStatus" + } + }, "/v1/WebChannels": { "servers": [ { @@ -7819,6 +8330,12 @@ { "name": "FlexV1InsightsAssessmentsComment" }, + { + "name": "FlexV1InsightsConversationalAi" + }, + { + "name": "FlexV1InsightsConversationalAiReportInsights" + }, { "name": "FlexV1InsightsConversations" }, @@ -7867,6 +8384,9 @@ { "name": "FlexV1InteractionContextLookupSid" }, + { + "name": "FlexV1InteractionContextUpdate" + }, { "name": "FlexV1LibraryPlugin" }, @@ -7891,14 +8411,25 @@ { "name": "FlexV1PluginVersion" }, + { + "name": "FlexV1ProvisioningStatus" + }, { "name": "FlexV1PublicConfiguration" }, + { + "name": "FlexV1Transfer" + }, { "name": "FlexV1VirtualAgentData" }, { "name": "FlexV1WebChannel" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index fac0221c..1f7663d1 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -166,6 +166,17 @@ }, { "name": "FlexV2WebChannels" + }, + { + "name": "FlexV2WebchatInitToken" + }, + { + "name": "FlexV2WebchatRefreshToken" + } + ], + "security": [ + { + "accountSid_authToken": [] } ] } \ No newline at end of file diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index 6ba2badd..36b5e740 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -21,12 +21,24 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive." + "description": "The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the User." + "description": "The string that you assigned to describe the User.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "avatar": { "type": "string", @@ -238,5 +250,10 @@ { "name": "FrontlineV1User" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index ab195f15..6219724e 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -98,8 +98,7 @@ "url": { "type": "string", "format": "uri", - "nullable": true, - "description": "The URL of this resource." + "nullable": true } } }, @@ -231,11 +230,23 @@ }, "from": { "nullable": true, - "description": "The calling party." + "description": "The calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { "nullable": true, - "description": "The called party." + "description": "The called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier_edge": { "nullable": true, @@ -373,7 +384,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "Custom label for the conference resource, up to 64 characters." + "description": "Custom label for the conference resource, up to 64 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "create_time": { "type": "string", @@ -561,7 +578,13 @@ "label": { "type": "string", "nullable": true, - "description": "The user-specified label of this participant." + "description": "The user-specified label of this participant.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "conference_sid": { "type": "string", @@ -596,12 +619,24 @@ "from": { "type": "string", "nullable": true, - "description": "Caller ID of the calling party." + "description": "Caller ID of the calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { "type": "string", "nullable": true, - "description": "Called party." + "description": "Called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "call_status": { "type": "string", @@ -996,11 +1031,23 @@ }, "from": { "nullable": true, - "description": "The calling party." + "description": "The calling party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "to": { "nullable": true, - "description": "The called party." + "description": "The called party.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier_edge": { "nullable": true, @@ -1849,13 +1896,13 @@ "mapping": { "call_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Voice/{call_sid}/Summary" }, "annotation": { "mapping": { "call_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Voice/{call_sid}/Annotation" } }, "mountName": "calls", @@ -1949,6 +1996,12 @@ "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 + } } }, { @@ -1957,6 +2010,12 @@ "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 + } } }, { @@ -3504,6 +3563,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readWithFriendlynameStartfailure": { "value": "outboundConfCallTransferThrice_1" @@ -4244,6 +4309,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readWithLabel": { "value": "client" @@ -5823,5 +5894,10 @@ { "name": "InsightsV1Setting" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index 4d218318..4ccd8102 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -114,6 +114,10 @@ "nullable": true, "description": "List of text extraction results. This might be available on classify-extract model outputs." }, + "text_generation_results": { + "nullable": true, + "description": "Output of a text generation operator for example Conversation Sumamary." + }, "transcript_sid": { "type": "string", "minLength": 34, @@ -166,7 +170,13 @@ "transcript": { "type": "string", "nullable": true, - "description": "Transcript text." + "description": "Transcript text.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -211,7 +221,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "date_created": { "type": "string", @@ -329,7 +339,7 @@ "data_logging": { "type": "boolean", "nullable": true, - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "language_code": { "type": "string", @@ -649,6 +659,7 @@ "predicted_probability": "0.05", "label_probabilities": {}, "extract_results": {}, + "text_generation_results": {}, "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } @@ -760,6 +771,7 @@ "predicted_probability": "0.05", "label_probabilities": {}, "extract_results": {}, + "text_generation_results": {}, "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } @@ -1047,7 +1059,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", @@ -1415,7 +1427,7 @@ }, "DataLogging": { "type": "boolean", - "description": "Data logging allows Twilio to improve the quality of the speech recognition through using customer data to refine its speech recognition models." + "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", @@ -1489,7 +1501,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Transcripts/{sid}/Media" }, "operator_results": { "mapping": { @@ -1933,7 +1945,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Transcripts/{sid}/Media" }, "operator_results": { "mapping": { @@ -2061,5 +2073,10 @@ { "name": "IntelligenceV2Transcript" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index 99a0a028..d754e7cd 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -5577,5 +5577,10 @@ { "name": "IpMessagingV1UserChannel" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 1d1aad57..236cc110 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -7470,5 +7470,10 @@ { "name": "IpMessagingV2Webhook" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_bulk.json b/spec/json/twilio_lookups_bulk.json deleted file mode 100644 index be932201..00000000 --- a/spec/json/twilio_lookups_bulk.json +++ /dev/null @@ -1,504 +0,0 @@ -{ - "openapi": "3.0.3", - "info": { - "title": "Lookup", - "termsOfService": "https://www.twilio.com/legal/tos", - "version": "1.0.0-alpha.1", - "description": "Lookup APIs for individual, bulk and job based requests\n\nDiscussion topics:\n- API version to use\n- Using or not lookup in the path or just as lookups subdomain", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "servers": [ - { - "url": "https://lookups.twilio.com" - } - ], - "paths": { - "/v2/batch/query": {} - }, - "components": { - "schemas": { - "LookupRequest": { - "title": "Lookup request", - "type": "object", - "properties": { - "phone_number": { - "type": "string" - }, - "fields": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "caller_name", - "sim_swap", - "call_forwarding", - "live_activity", - "line_type_intelligence", - "identity_match", - "reassigned_number", - "sms_pumping_risk", - "disposable_phone_number_risk" - ] - } - }, - "country_code": { - "type": "string" - }, - "identity_match": { - "$ref": "#/components/schemas/IdentityMatchParameters" - }, - "reassigned_number": { - "$ref": "#/components/schemas/ReassignedNumberRequest" - } - }, - "required": [ - "phone_number" - ], - "description": "" - }, - "LookupRequestWithCorId": { - "title": "LookupRequestWithCorId", - "allOf": [ - { - "$ref": "#/components/schemas/LookupRequest" - } - ], - "type": "object", - "properties": { - "correlation_id": { - "type": "string", - "description": "Unique identifier used to match request with response" - } - } - }, - "LookupResponse": { - "title": "LookupResponse", - "type": "object", - "properties": { - "calling_country_code": { - "type": "string" - }, - "country_code": { - "type": "string" - }, - "phone_number": { - "type": "string" - }, - "national_format": { - "type": "string" - }, - "valid": { - "type": "boolean" - }, - "validation_errors": { - "type": "array", - "items": { - "type": "string" - } - }, - "caller_name": { - "$ref": "#/components/schemas/CallerName" - }, - "sim_swap": { - "$ref": "#/components/schemas/SimSwap" - }, - "call_forwarding": { - "$ref": "#/components/schemas/CallForwarding" - }, - "live_activity": { - "$ref": "#/components/schemas/LiveActivity" - }, - "line_type_intelligence": { - "$ref": "#/components/schemas/LineTypeIntelligence" - }, - "identity_match": { - "$ref": "#/components/schemas/IdentityMatch" - }, - "reassigned_number": { - "$ref": "#/components/schemas/ReassignedNumberResponse" - }, - "sms_pumping_risk": { - "$ref": "#/components/schemas/SmsPumpingRisk" - }, - "disposable_phone_number_risk": { - "$ref": "#/components/schemas/DisposablePhoneNumberRisk" - } - } - }, - "LookupResponseWithCorId": { - "allOf": [ - { - "$ref": "#/components/schemas/LookupResponse" - } - ], - "type": "object", - "properties": { - "correlation_id": { - "type": "string", - "description": "Unique identifier used to match request with response" - }, - "twilio_error_code": { - "type": "integer", - "description": "Twilio error conde in case that the request to downstream fails" - } - } - }, - "CallerName": { - "title": "CallerName", - "type": "object", - "properties": { - "caller_name": { - "type": "string" - }, - "caller_type": { - "type": "string" - }, - "error_code": { - "type": "integer" - } - } - }, - "SimSwap": { - "title": "SimSwap", - "allOf": [ - { - "$ref": "#/components/schemas/ATOCarrier" - } - ], - "properties": { - "last_sim_swap": { - "$ref": "#/components/schemas/LastSimSwap" - }, - "error_code": { - "type": "integer" - } - }, - "type": "object" - }, - "LastSimSwap": { - "title": "SimSwap", - "properties": { - "last_sim_swap_date": { - "type": "string", - "format": "date-time" - }, - "swapped_period": { - "type": "string" - }, - "swapped_in_period": { - "type": "boolean" - } - } - }, - "CallForwarding": { - "title": "CallForwarding", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ATOCarrier" - } - ], - "properties": { - "call_forwarding_enabled": { - "type": "boolean" - }, - "error_code": { - "type": "integer" - } - } - }, - "ATOCarrier": { - "title": "ATOCarrier", - "type": "object", - "properties": { - "carrier_name": { - "type": "string" - }, - "mobile_country_code": { - "type": "string" - }, - "mobile_network_code": { - "type": "string" - } - } - }, - "LiveActivity": { - "title": "LiveActivity", - "type": "object", - "properties": { - "connectivity": { - "type": "string" - }, - "original_carrier": { - "$ref": "#/components/schemas/LiveActivityCarrier" - }, - "ported": { - "type": "string" - }, - "ported_carrier": { - "$ref": "#/components/schemas/LiveActivityCarrier" - }, - "roaming": { - "type": "string" - }, - "roaming_carrier": { - "$ref": "#/components/schemas/LiveActivityCarrier" - }, - "error_code": { - "type": "integer" - } - } - }, - "LiveActivityCarrier": { - "title": "LiveActivityCarrier", - "allOf": [ - { - "$ref": "#/components/schemas/Carrier" - } - ], - "properties": { - "name": { - "type": "string" - }, - "country": { - "type": "string" - } - }, - "type": "object" - }, - "LineTypeIntelligence": { - "title": "Packages/LineTypeIntelligence", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ATOCarrier" - } - ], - "properties": { - "type": { - "type": "string" - }, - "error_code": { - "type": "integer" - } - } - }, - "Carrier": { - "title": "Carrier", - "type": "object", - "properties": { - "mobile_country_code": { - "type": "string" - }, - "mobile_network_code": { - "type": "string" - } - } - }, - "IdentityMatch": { - "title": "IdentityMatch", - "type": "object", - "properties": { - "first_name_match": { - "type": "string" - }, - "last_name_match": { - "type": "string" - }, - "address_line_match": { - "type": "string" - }, - "city_match": { - "type": "string" - }, - "state_match": { - "type": "string" - }, - "postal_code_match": { - "type": "string" - }, - "country_code_match": { - "type": "string" - }, - "national_id_match": { - "type": "string" - }, - "date_of_birth_match": { - "type": "string" - }, - "summary_score": { - "type": "integer" - }, - "error_code": { - "type": "integer" - }, - "error_message": { - "type": "string" - } - } - }, - "IdentityMatchParameters": { - "title": "IdentityMatchParameters", - "type": "object", - "properties": { - "first_name": { - "type": "string" - }, - "last_name": { - "type": "string" - }, - "address_line1": { - "type": "string" - }, - "address_line2": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "postal_code": { - "type": "string" - }, - "address_country_code": { - "type": "string" - }, - "national_id": { - "type": "string" - }, - "date_of_birth": { - "type": "string" - } - } - }, - "ReassignedNumberRequest": { - "title": "ReassignedNumberRequest", - "type": "object", - "properties": { - "last_verified_date": { - "type": "string", - "maxLength": 8 - } - } - }, - "ReassignedNumberResponse": { - "title": "ReassignedNumberResponse", - "type": "object", - "properties": { - "last_verified_date": { - "type": "string" - }, - "is_number_reassigned": { - "type": "string" - }, - "error_code": { - "type": "string" - } - } - }, - "SmsPumpingRiskCarrier": { - "title": "SmsPumpingRiskCarrier", - "allOf": [ - { - "$ref": "#/components/schemas/Carrier" - } - ], - "properties": { - "name": { - "type": "string" - }, - "carrier_risk_score": { - "type": "integer" - }, - "carrier_risk_category": { - "type": "string" - } - }, - "type": "object" - }, - "SmsPumpingRisk": { - "title": "SmsPumpingRisk", - "type": "object", - "properties": { - "carrier": { - "$ref": "#/components/schemas/SmsPumpingRiskCarrier" - }, - "number_blocked": { - "type": "boolean" - }, - "number_blocked_date": { - "type": "string", - "format": "date-time" - }, - "number_blocked_last_3_months": { - "type": "boolean" - }, - "sms_pumping_risk_score": { - "type": "integer" - }, - "error_code": { - "type": "integer" - } - } - }, - "DisposablePhoneNumberRiskCarrier": { - "title": "DisposablePhoneNumberRiskCarrier", - "allOf": [ - { - "$ref": "#/components/schemas/Carrier" - } - ], - "properties": { - "name": { - "type": "string" - }, - "carrier_risk_score": { - "type": "integer" - }, - "carrier_risk_category": { - "type": "string" - }, - "line_type": { - "type": "string" - } - }, - "type": "object" - }, - "DisposablePhoneNumberRisk": { - "title": "DisposablePhoneNumberRisk", - "type": "object", - "properties": { - "carrier": { - "$ref": "#/components/schemas/DisposablePhoneNumberRiskCarrier" - }, - "disposable_phone_risk_category": { - "type": "string" - }, - "disposable_phone_risk_score": { - "type": "integer" - }, - "velocity_risk_category": { - "type": "string" - }, - "velocity_risk_score": { - "type": "integer" - }, - "error_code": { - "type": "integer" - } - } - } - }, - "requestBodies": {} - } -} \ No newline at end of file diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 1c0e3747..450ad045 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -12,23 +12,47 @@ "properties": { "caller_name": { "nullable": true, - "description": "The name of the phone number's owner. If `null`, that information was not available." + "description": "The name of the phone number's owner. If `null`, that information was not available.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "country_code": { "type": "string", "nullable": true, - "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number." + "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "national_format": { "type": "string", "nullable": true, - "description": "The phone number, in national format." + "description": "The phone number, in national format.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "carrier": { "nullable": true, @@ -36,7 +60,13 @@ }, "add_ons": { "nullable": true, - "description": "A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons)." + "description": "A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -84,7 +114,8 @@ "defaultOutputProperties": [ "caller_name", "country_code", - "carrier" + "carrier", + "url" ], "pathType": "instance" }, @@ -102,6 +133,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -111,6 +148,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "fetchCarrier": { "value": "country_code" @@ -194,6 +237,12 @@ "type": "string" } }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "fetchAddonsWhitepagesPro": { "value": [ @@ -485,5 +534,10 @@ { "name": "LookupsV1PhoneNumber" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index 2fb3820c..63a904bd 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -18,18 +18,36 @@ "country_code": { "type": "string", "nullable": true, - "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." + "description": "The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number." + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "national_format": { "type": "string", "nullable": true, - "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers)." + "description": "The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "valid": { "type": "boolean", @@ -47,7 +65,13 @@ }, "caller_name": { "nullable": true, - "description": "An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID)." + "description": "An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sim_swap": { "nullable": true, @@ -157,6 +181,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -223,6 +253,12 @@ "description": "The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -337,6 +373,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + }, "examples": { "fetchIdentityMatch": { "value": "YZ3456883" @@ -350,6 +392,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + }, "examples": { "fetchIdentityMatch": { "value": "19901214" @@ -551,10 +599,7 @@ "caller_name": null, "sim_swap": null, "call_forwarding": { - "call_forwarding_status": "true", - "carrier_name": "Vodafone UK", - "mobile_country_code": "276", - "mobile_network_code": "02", + "call_forwarding_status": true, "error_code": null }, "live_activity": null, @@ -587,10 +632,7 @@ "error_code": null }, "call_forwarding": { - "call_forwarding_status": "true", - "carrier_name": "Vodafone UK", - "mobile_country_code": "276", - "mobile_network_code": "02", + "call_forwarding_status": true, "error_code": null }, "live_activity": null, @@ -782,13 +824,7 @@ "identity_match": null, "reassigned_number": null, "sms_pumping_risk": { - "carrier": { - "name": "Twilio Carrier", - "mobile_country_code": "214", - "mobile_network_code": "07", - "carrier_risk_score": 69, - "carrier_risk_category": "moderate" - }, + "carrier_risk_category": "moderate", "number_blocked": false, "number_blocked_date": null, "number_blocked_last_3_months": null, @@ -929,5 +965,10 @@ { "name": "LookupsV2PhoneNumber" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index 95841d76..41334914 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -41,7 +41,13 @@ "extension": { "type": "string", "nullable": true, - "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`" + "description": "The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "extension_context": { "type": "string", @@ -982,13 +988,13 @@ "mapping": { "media_recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/TimedMetadata" }, "media": { "mapping": { "media_recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/Media" } }, "mountName": "media_recording", @@ -1105,13 +1111,13 @@ "mapping": { "media_recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/TimedMetadata" }, "media": { "mapping": { "media_recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/MediaRecordings/{media_recording_sid}/Media" } }, "mountName": "media_recording", @@ -1352,19 +1358,19 @@ "mapping": { "player_streamer_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata" }, "playback_grant": { "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{sid}/PlaybackGrant" }, "recording_playback_grant": { "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{sid}/RecordingPlaybackGrant" } }, "mountName": "player_streamer", @@ -1533,19 +1539,19 @@ "mapping": { "player_streamer_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata" }, "playback_grant": { "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{sid}/PlaybackGrant" }, "recording_playback_grant": { "mapping": { "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/PlayerStreamers/{sid}/RecordingPlaybackGrant" } }, "mountName": "player_streamer", @@ -2044,5 +2050,10 @@ { "name": "MediaV1TranscriptionDefaultSettings" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_messaging_bulk_v1.json b/spec/json/twilio_messaging_bulk_v1.json index 3ea93074..cb524c59 100644 --- a/spec/json/twilio_messaging_bulk_v1.json +++ b/spec/json/twilio_messaging_bulk_v1.json @@ -1,5 +1,10 @@ { "openapi": "3.0.3", + "security": [ + { + "accountSid_authToken": [] + } + ], "info": { "title": "Bulk Messaging and Broadcast", "description": "Bulk Sending is a public Twilio REST API for 1:Many Message creation up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message creation up to 10,000 recipients via file upload.", @@ -231,6 +236,22 @@ } ] } + }, + "/v1/Broadcasts/{BroadcastSid}/Cancel": { + "parameters": [ + { + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^BC[0-9a-fA-F]{32}$" + }, + "name": "BroadcastSid", + "description": "Id of an existing Broadcast.", + "in": "path", + "required": true + } + ] } }, "components": { @@ -360,10 +381,10 @@ } } }, - "errors_file": { + "results_file": { "type": "string", "format": "uri", - "description": "Path to a file detailing errors from Broadcast execution" + "description": "Path to a file detailing successful requests and errors from Broadcast execution" } } }, @@ -393,8 +414,8 @@ }, "securitySchemes": { "accountSid_authToken": { - "type": "http", - "scheme": "basic" + "scheme": "basic", + "type": "http" } } } diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index e6e1eb70..d178ddf1 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -374,7 +374,8 @@ "url": { "type": "string", "format": "uri", - "nullable": true + "nullable": true, + "description": "The absolute URL of the ChannelSender resource." } } }, @@ -1148,6 +1149,11 @@ "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." @@ -1241,6 +1247,21 @@ "nullable": true, "description": "Indicates that this SMS campaign will send messages that contain phone numbers." }, + "subscriber_opt_in": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign has Subscriber Optin or not." + }, + "age_gated": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign is age gated or not." + }, + "direct_lending": { + "type": "boolean", + "nullable": true, + "description": "A boolean that specifies whether campaign allows direct lending or not." + }, "campaign_status": { "type": "string", "nullable": true, @@ -1601,12 +1622,12 @@ "value": { "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, "key": "alpha_senders", - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0" + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0" }, "alpha_senders": [ { @@ -2892,12 +2913,12 @@ "value": { "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, "key": "senders", - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=50&Page=0" + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0" }, "senders": [ { @@ -4050,12 +4071,12 @@ "value": { "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, "key": "phone_numbers", - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0" + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0" }, "phone_numbers": [ { @@ -4535,12 +4556,12 @@ "value": { "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, "key": "services", - "url": "https://messaging.twilio.com/v1/Services?PageSize=50&Page=0" + "url": "https://messaging.twilio.com/v1/Services?PageSize=20&Page=0" }, "services": [ { @@ -5138,12 +5159,12 @@ "value": { "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, "key": "short_codes", - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0" + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0" }, "short_codes": [ { @@ -5379,6 +5400,7 @@ "rejection_reason": null, "error_code": null, "edit_expiration": null, + "edit_allowed": null, "resource_links": { "customer_profile": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "trust_product": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -5468,6 +5490,7 @@ "rejection_reason": null, "error_code": null, "edit_expiration": null, + "edit_allowed": null, "resource_links": {}, "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "external_reference_id": null @@ -5579,6 +5602,10 @@ "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'." } } }, @@ -5610,13 +5637,45 @@ ], "OptInType": "VERBAL", "MessageVolume": "1,000", - "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy" + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy", + "EditReason": "Website fixed" } } } } } } + }, + "delete": { + "description": "", + "tags": [ + "MessagingV1TollfreeVerification" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The unique string to identify Tollfree Verification.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^HH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteTollfreeVerification" } }, "/v1/Tollfree/Verifications": { @@ -5799,6 +5858,7 @@ "rejection_reason": null, "error_code": null, "edit_expiration": null, + "edit_allowed": null, "resource_links": { "customer_profile": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "trust_product": "https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -5875,6 +5935,7 @@ "rejection_reason": null, "error_code": null, "edit_expiration": null, + "edit_allowed": null, "resource_links": {}, "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "external_reference_id": "abc123xyz567" @@ -5920,6 +5981,7 @@ "rejection_reason": null, "error_code": null, "edit_expiration": null, + "edit_allowed": null, "resource_links": {}, "url": "https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "external_reference_id": "abc123xyz567" @@ -6184,6 +6246,9 @@ "us_app_to_person_usecase": "MARKETING", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": false, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6230,6 +6295,9 @@ "us_app_to_person_usecase": "MARKETING", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6282,6 +6350,9 @@ "us_app_to_person_usecase": "SOLE_PROPRIETOR", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6405,6 +6476,18 @@ "type": "string" }, "description": "End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum." + }, + "SubscriberOptIn": { + "type": "boolean", + "description": "A boolean that specifies whether campaign has Subscriber Optin or not." + }, + "AgeGated": { + "type": "boolean", + "description": "A boolean that specifies whether campaign is age gated or not." + }, + "DirectLending": { + "type": "boolean", + "description": "A boolean that specifies whether campaign allows direct lending or not." } }, "required": [ @@ -6441,7 +6524,10 @@ "HELP" ], "HasEmbeddedLinks": true, - "HasEmbeddedPhone": false + "HasEmbeddedPhone": false, + "SubscriberOptIn": false, + "AgeGated": false, + "DirectLending": false } }, "createWithDefaults": { @@ -6459,7 +6545,9 @@ "START" ], "HasEmbeddedLinks": true, - "HasEmbeddedPhone": false + "HasEmbeddedPhone": false, + "AgeGated": false, + "DirectLending": false } }, "createWithDefaultsSoleProprietor": { @@ -6477,7 +6565,9 @@ "START" ], "HasEmbeddedLinks": true, - "HasEmbeddedPhone": false + "HasEmbeddedPhone": false, + "AgeGated": false, + "DirectLending": false } } } @@ -6596,6 +6686,9 @@ "us_app_to_person_usecase": "MARKETING", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6630,11 +6723,11 @@ ], "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", "key": "compliance" } } @@ -6655,6 +6748,9 @@ "us_app_to_person_usecase": "MARKETING", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6698,11 +6794,11 @@ ], "meta": { "page": 0, - "page_size": 50, - "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "page_size": 20, + "first_page_url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", "previous_page_url": null, "next_page_url": null, - "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0", "key": "compliance" } } @@ -6834,6 +6930,9 @@ "us_app_to_person_usecase": "MARKETING", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6880,6 +6979,9 @@ "us_app_to_person_usecase": "SOLE_PROPRIETOR", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6926,6 +7028,9 @@ "us_app_to_person_usecase": "SOLE_PROPRIETOR", "has_embedded_links": true, "has_embedded_phone": false, + "subscriber_opt_in": true, + "age_gated": false, + "direct_lending": false, "campaign_status": "PENDING", "campaign_id": "CFOOBAR", "is_externally_registered": false, @@ -6979,6 +7084,175 @@ } ], "operationId": "FetchUsAppToPerson" + }, + "post": { + "description": "", + "tags": [ + "MessagingV1UsAppToPerson" + ], + "parameters": [ + { + "name": "MessagingServiceSid", + "in": "path", + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^QE[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messaging.v1.service.us_app_to_person" + }, + "examples": { + "update": { + "value": { + "sid": "QE2c6890da8086d771620e9b13fadeba0b", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "brand_registration_sid": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "Send marketing messages about sales to opted in customers.", + "message_samples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "us_app_to_person_usecase": "MARKETING", + "has_embedded_links": true, + "has_embedded_phone": false, + "campaign_status": "PENDING", + "campaign_id": "CFOOBAR", + "is_externally_registered": false, + "rate_limits": { + "att": { + "mps": 600, + "msg_class": "A" + }, + "tmobile": { + "brand_tier": "TOP" + } + }, + "subscriber_opt_in": false, + "age_gated": false, + "direct_lending": false, + "date_created": "2021-02-18T14:48:52Z", + "date_updated": "2021-02-18T14:48:52Z", + "url": "https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b", + "message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP", + "opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.", + "opt_in_keywords": [ + "START" + ], + "opt_out_keywords": [ + "STOP" + ], + "help_keywords": [ + "HELP" + ], + "help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.", + "mock": false, + "errors": [] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateUsAppToPerson", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateUsAppToPersonRequest", + "properties": { + "HasEmbeddedLinks": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain links." + }, + "HasEmbeddedPhone": { + "type": "boolean", + "description": "Indicates that this SMS campaign will send messages that contain phone numbers." + }, + "MessageSamples": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars." + }, + "MessageFlow": { + "type": "string", + "description": "Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum." + }, + "Description": { + "type": "string", + "description": "A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters." + }, + "AgeGated": { + "type": "boolean", + "description": "A boolean that specifies whether campaign requires age gate for federally legal content." + }, + "DirectLending": { + "type": "boolean", + "description": "A boolean that specifies whether campaign allows direct lending or not." + } + }, + "required": [ + "HasEmbeddedLinks", + "HasEmbeddedPhone", + "MessageSamples", + "MessageFlow", + "Description", + "AgeGated", + "DirectLending" + ] + }, + "examples": { + "update": { + "value": { + "Description": "Send marketing messages about sales to opted in customers.", + "MessageSamples": [ + "EXPRESS: Denim Days Event is ON", + "LAST CHANCE: Book your next flight for just 1 (ONE) EUR" + ], + "MessageFlow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.", + "HasEmbeddedLinks": true, + "HasEmbeddedPhone": false, + "AgeGated": false, + "DirectLending": false + } + } + } + } + } + } } }, "/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases": { @@ -7434,5 +7708,10 @@ { "name": "MessagingV1WhatsappTemplate" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index 6565f964..aa431f64 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -1035,7 +1035,7 @@ "mapping": { "app_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Apps/{app_sid}/Manifest" } }, "pathType": "list" @@ -1195,7 +1195,7 @@ "mapping": { "app_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Apps/{app_sid}/Manifest" } }, "pathType": "instance" @@ -2630,5 +2630,10 @@ { "name": "MicrovisorV1LoggingToken" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 1068bb10..9f527499 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -1000,5 +1000,10 @@ { "name": "MonitorV1Event" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index eabfb113..24d47d93 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -67,7 +67,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service." + "description": "The `identity` value that uniquely identifies the resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "binding_type": { "type": "string", @@ -77,7 +83,13 @@ "address": { "type": "string", "nullable": true, - "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format." + "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 120 + } + } }, "tags": { "type": "array", @@ -85,7 +97,13 @@ "type": "string" }, "nullable": true, - "description": "The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed." + "description": "The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "url": { "type": "string", @@ -214,7 +232,13 @@ "type": "string" }, "nullable": true, - "description": "The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list." + "description": "The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "tags": { "type": "array", @@ -222,7 +246,13 @@ "type": "string" }, "nullable": true, - "description": "The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property." + "description": "The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + } }, "segments": { "type": "array", @@ -251,7 +281,13 @@ "body": { "type": "string", "nullable": true, - "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification." + "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "sound": { "type": "string", @@ -366,7 +402,7 @@ "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set." }, "facebook_messenger_page_id": { "type": "string", @@ -786,6 +822,12 @@ "type": "string" } }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 120 + } + }, "examples": { "readEmpty": { "value": [ @@ -1543,7 +1585,7 @@ "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref)." }, "Sms": { - "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." + "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array." }, "FacebookMessenger": { "description": "Deprecated." @@ -1744,7 +1786,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", @@ -2216,7 +2258,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^MG[0-9a-fA-F]{32}$", - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications." }, "FacebookMessengerPageId": { "type": "string", @@ -2317,5 +2359,10 @@ { "name": "NotifyV1UserBinding" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index d8c948e4..79f79e50 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -214,7 +214,7 @@ "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Port In request, It is the request identifier" + "description": "The SID of the Port In request. This is a unique identifier of the port in request." }, "url": { "type": "string", @@ -223,6 +223,75 @@ } } }, + "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": { @@ -712,7 +781,7 @@ "pathType": "list" }, "post": { - "description": "Allows to create a port in request ", + "description": "Allows to create a new port in request", "tags": [ "NumbersV1PortingPortIn" ], @@ -727,7 +796,7 @@ "create": { "value": { "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://numbers.twilio.com/v1/Porting/PortIn" + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -744,6 +813,104 @@ "operationId": "CreatePortingPortIn" } }, + "/v1/Porting/PortIn/{PortInRequestSid}": { + "servers": [ + { + "url": "https://numbers.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "port_in_request_sid" + ], + "mountName": "porting_port_ins", + "className": "porting_port_in_fetch", + "pathType": "instance" + }, + "get": { + "description": "Fetch a port in request by SID", + "tags": [ + "NumbersV1PortingPortInFetch" + ], + "parameters": [ + { + "name": "PortInRequestSid", + "in": "path", + "description": "The SID of the Port In request. This is a unique identifier of the port in request.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KW[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/numbers.v1.porting_port_in_fetch" + }, + "examples": { + "fetch": { + "value": { + "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "notification_emails": [ + "user@domain.com" + ], + "target_port_in_date": "2023-09-10", + "target_port_in_time_range_start": "10:00:00+01:00", + "target_port_in_time_range_end": "20:00:00+01:00", + "losing_carrier_information": { + "customer_type": "Business/Individual", + "customer_name": "Customer name for carrier", + "authorized_representative": "John Smith", + "authorized_representative_email": "signer@domain.com", + "account_number": "123456", + "account_telephone_number": "+133232323", + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address": { + "street": "Your Street", + "street_2": "Other Street or null", + "city": "City", + "state": "State", + "zip": "000000", + "country": "US" + } + }, + "phone_numbers": [ + { + "phone_number": "+16175551212", + "pin": "123456", + "portable": true, + "not_portability_reason": "string", + "not_portability_reason_code": 0 + } + ], + "documents": [ + "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPortingPortInFetch" + } + }, "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { "servers": [ { @@ -860,11 +1027,19 @@ { "name": "NumbersV1PortingPortIn" }, + { + "name": "NumbersV1PortingPortInFetch" + }, { "name": "NumbersV1PortingPortability" }, { "name": "NumbersV1ProofOfAddress" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index 595e8bba..8b3e5874 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -35,7 +35,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing." + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -43,7 +49,13 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "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", @@ -99,12 +111,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 128 character string that is a human-readable text that describes this resource." + "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." + "description": "Email address used for send notifications about this Bulk hosted number request.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -133,7 +157,13 @@ "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'." + "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 + } + } } } }, @@ -430,7 +460,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 128 characters." + "description": "A human readable description of this resource, up to 128 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -458,7 +494,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -466,7 +508,13 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + "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", @@ -525,7 +573,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -702,7 +756,13 @@ "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" + "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", @@ -727,7 +787,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 128 character string that is a human-readable text that describes this resource." + "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", @@ -755,7 +821,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -763,7 +835,13 @@ "type": "string" }, "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + "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", @@ -1047,7 +1125,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -1275,6 +1359,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "test+hosted@twilio.com" @@ -2807,6 +2897,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "example" @@ -4507,6 +4603,12 @@ "type": "string", "format": "phone-number" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "+19193608000" @@ -4536,6 +4638,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "example" @@ -5437,10 +5545,23 @@ { "name": "Individual", "type": "individual", + "requirement_name": "individual_info", "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", "fields": [ "first_name", "last_name" + ], + "detailed_fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "description": "First name of the Individual" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "description": "Last name of the Individual" + } ] } ], @@ -5449,13 +5570,23 @@ { "name": "Address", "type": "document", + "requirement_name": "proof_of_address", "description": "The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required.", "accepted_documents": [ { "name": "Address Validation", "type": "address", "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address", - "fields": [] + "fields": [ + "address_sids" + ], + "detailed_fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address sid(s)", + "description": "Address sid of the individual" + } + ] } ] } @@ -5544,10 +5675,23 @@ { "name": "Individual", "type": "individual", + "requirement_name": "individual_info", "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual", "fields": [ "first_name", "last_name" + ], + "detailed_fields": [ + { + "machine_name": "first_name", + "friendly_name": "First Name", + "description": "First name of the Individual" + }, + { + "machine_name": "last_name", + "friendly_name": "Last Name", + "description": "Last name of the Individual" + } ] } ], @@ -5556,13 +5700,23 @@ { "name": "Address", "type": "document", + "requirement_name": "proof_of_address", "description": "The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required.", "accepted_documents": [ { "name": "Address Validation", "type": "address", "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address", - "fields": [] + "fields": [ + "address_sids" + ], + "detailed_fields": [ + { + "machine_name": "address_sids", + "friendly_name": "Address sid(s)", + "description": "Address sid of the individual" + } + ] } ] } @@ -6424,5 +6578,10 @@ { "name": "NumbersV2SupportingDocumentType" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_oauth_v1.json b/spec/json/twilio_oauth_v1.json deleted file mode 100644 index ddb2807d..00000000 --- a/spec/json/twilio_oauth_v1.json +++ /dev/null @@ -1,681 +0,0 @@ -{ - "components": { - "securitySchemes": { - "accountSid_authToken": { - "scheme": "basic", - "type": "http" - } - }, - "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 - } - } - } - } - }, - "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.0.0" - }, - "openapi": "3.0.1", - "paths": { - "/v1/certs": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "keys" - ], - "mountName": "oauth", - "pathType": "instance" - }, - "get": { - "description": "Fetches public JWKs", - "tags": [ - "OauthV1Oauth" - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/oauth.v1.certs" - }, - "examples": { - "fetch": { - "value": { - "keys": [ - { - "alg": "ES256", - "kid": "IC10c8172f35dd36f20d9ed2fcc0b818c7", - "key_ops": [], - "use": "sig", - "crv": "P-256", - "x": "hrJ4NKauVYBiREgIY_EPPj10zHIiOHeIf3-LGODt_KM", - "y": "c3IcyhpvfMIMpqd_ku9Q_4n20nMlelUF-zSmRXEIFEU", - "kty": "EC" - } - ], - "url": "https://oauth.twilio.com/v1/certs" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchCerts" - } - }, - "/v1/device/code": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "device_code", - "user_code", - "verification_uri", - "verification_uri_complete", - "expires_in", - "interval" - ], - "mountName": "device_code", - "pathType": "list" - }, - "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" - }, - "examples": { - "create": { - "value": { - "device_code": "LiwuhE0bIhqemK6sd34tXfobVCR9yrk0", - "user_code": "Hkf1WaID3", - "verification_uri": "v1/oauth2/device/activate", - "verification_uri_complete": "v1/oauth2/device/activate?user_code=Hkf1WaID3", - "expires_in": 299, - "interval": 5 - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeviceCode", - "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" - ] - }, - "examples": { - "create": { - "value": { - "ClientSid": "OQ693217fa7610373e7762f06645058bac", - "Scopes": [ - "test-scope" - ], - "Audiences": [ - "http://dev.twilio.com/" - ] - } - } - } - } - } - } - } - }, - "/v1/.well-known/openid-configuration": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "", - "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" - ], - "mountName": "openid_discovery", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "issuer": "https://iam.twilio.com", - "authorization_endpoint": "https://oauth.twilio.com/oauth2/authorize", - "device_authorization_endpoint": "https://oauth.twilio.com/oauth2/device/authorize", - "token_endpoint": "https://oauth.twilio.com/oauth2/token", - "userinfo_endpoint": "https://oauth.twilio.com/oauth2/userinfo", - "revocation_endpoint": "https://oauth.twilio.com/oauth2/revoke", - "jwk_uri": "https://oauth.twilio.com/oauth2/certs", - "response_type_supported": [ - "code", - "token" - ], - "subject_type_supported": [ - "account_sid", - "user_sid" - ], - "id_token_signing_alg_values_supported": [ - "ECDSA", - "RSA256" - ], - "scopes_supported": [ - "openid", - "profile", - "email" - ], - "claims_supported": [ - "act", - "aud", - "cid", - "device_id", - "exp", - "jti", - "iat", - "iss", - "nbf", - "scp", - "sub" - ], - "url": "https://oauth.twilio.com/v1/.well-known/openid-configuration" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchOpenidDiscovery" - } - }, - "/v1/token": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "", - "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" - }, - "examples": { - "create": { - "value": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "refresh_token": "ghjbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "id_token": "eyJhbdGciOiIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", - "refresh_token_expires_at": "2015-07-31T04:00:00Z", - "access_token_expires_at": "2015-07-31T04:00:00Z" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateToken", - "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" - ] - }, - "examples": { - "create": { - "value": { - "GrantType": "authorization_code", - "ClientSid": "OQ09708361261756db8c0b555d36f55a65", - "ClientSecret": "client_secret", - "Code": "dfyguyhuijikokje456rt7y8uioklj", - "CodeVerifier": "code_verifier", - "DeviceCode": "device_code", - "RefreshToken": "refresh_token", - "DeviceId": "device_id" - } - } - } - } - } - } - } - }, - "/v1/userinfo": { - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [ - "user_sid" - ], - "mountName": "user_info", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "user_sid": "US57cc2449f1b38ed85cf1a43cd8166349", - "first_name": "Mafalda", - "last_name": "Rolfson", - "friendly_name": "mafalda.rolfson+oBgz@ct.sink.twilio.com", - "email": "mafalda.rolfson+oBgz@ct.sink.twilio.com", - "url": "https://oauth.twilio.com/v1/userinfo" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUserInfo" - } - } - }, - "servers": [ - { - "url": "https://oauth.twilio.com" - } - ], - "tags": [ - { - "name": "OauthV1DeviceCode" - }, - { - "name": "OauthV1Oauth" - }, - { - "name": "OauthV1OpenidDiscovery" - }, - { - "name": "OauthV1Token" - }, - { - "name": "OauthV1UserInfo" - } - ] -} \ No newline at end of file diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index 2ecabb7b..f074ac8a 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -357,7 +357,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email that this AuthorizationDocument will be sent to for signing." + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -365,7 +371,13 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed." + "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", @@ -473,12 +485,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this resource, up to 64 characters." + "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." + "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", @@ -511,7 +535,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -519,7 +549,13 @@ "type": "string" }, "nullable": true, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" + "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", @@ -653,12 +689,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "A 64 character string that is a human-readable text that describes this resource." + "description": "A 64 character string that is a human-readable text that describes this resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -691,7 +739,13 @@ "email": { "type": "string", "nullable": true, - "description": "Email of the owner of this phone number that is being hosted." + "description": "Email of the owner of this phone number that is being hosted.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cc_emails": { "type": "array", @@ -699,7 +753,13 @@ "type": "string" }, "nullable": true, - "description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + "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", @@ -1502,231 +1562,135 @@ } } }, - "preview.understand.assistant": { + "preview.wireless.command": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this 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" + "pattern": "^DC[0-9a-fA-F]{32}$", + "nullable": true }, - "friendly_name": { + "account_sid": { "type": "string", - "nullable": true, - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "latest_model_build_sid": { + "device_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UG[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID (Sid) of the latest model build. Null if no model has been built." - }, - "links": { - "type": "object", - "format": "uri-map", + "pattern": "^DE[0-9a-fA-F]{32}$", "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": { + "sim_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true }, - "unique_name": { + "command": { "type": "string", - "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." + "nullable": true }, - "url": { + "command_mode": { "type": "string", - "format": "uri", "nullable": true }, - "callback_url": { + "status": { "type": "string", - "format": "uri", - "nullable": true, - "description": "A user-provided URL to send event callbacks to." + "nullable": true }, - "callback_events": { + "direction": { "type": "string", - "nullable": true, - "description": "Space-separated list of callback events that will trigger callbacks." - } - } - }, - "preview.understand.assistant.assistant_fallback_actions": { - "type": "object", - "properties": { - "account_sid": { + "nullable": true + }, + "date_created": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "format": "date-time", "nullable": true }, - "assistant_sid": { + "date_updated": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", + "format": "date-time", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true - }, - "data": { - "nullable": true } } }, - "preview.understand.assistant.assistant_initiation_actions": { + "preview.wireless.rate_plan": { "type": "object", "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true - }, - "assistant_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", + "pattern": "^WP[0-9a-fA-F]{32}$", "nullable": true }, - "url": { + "unique_name": { "type": "string", - "format": "uri", "nullable": true }, - "data": { - "nullable": true - } - } - }, - "preview.understand.assistant.dialogue": { - "type": "object", - "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." + "nullable": true }, - "sid": { + "friendly_name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UK[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Dialogue" + "nullable": true }, - "data": { - "nullable": true, - "description": "The dialogue memory object as json" + "data_enabled": { + "type": "boolean", + "nullable": true }, - "url": { + "data_metering": { "type": "string", - "format": "uri", "nullable": true - } - } - }, - "preview.understand.assistant.task.field": { - "type": "object", - "properties": { - "account_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field." }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "data_limit": { + "type": "integer", + "nullable": true }, - "date_updated": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" + "messaging_enabled": { + "type": "boolean", + "nullable": true }, - "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." + "voice_enabled": { + "type": "boolean", + "nullable": true }, - "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." + "national_roaming_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." + "international_roaming": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true }, - "sid": { + "date_created": { "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." + "format": "date-time", + "nullable": true }, - "unique_name": { + "date_updated": { "type": "string", - "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "format": "date-time", + "nullable": true }, "url": { "type": "string", @@ -1735,5481 +1699,216 @@ } } }, - "preview.understand.assistant.field_type": { + "preview.wireless.sim": { "type": "object", "properties": { - "account_sid": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field Type." - }, - "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" + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true }, - "friendly_name": { + "unique_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": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true }, - "sid": { + "rate_plan_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "pattern": "^WP[0-9a-fA-F]{32}$", + "nullable": true }, - "unique_name": { + "friendly_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." + "nullable": true }, - "url": { + "iccid": { "type": "string", - "format": "uri", "nullable": true - } - } - }, - "preview.understand.assistant.field_type.field_value": { - "type": "object", - "properties": { - "account_sid": { + }, + "e_id": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Account that created this Field Value." + "nullable": true }, - "date_created": { + "status": { "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" + "nullable": true }, - "date_updated": { + "commands_callback_url": { "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "field_type_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UB[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Field Type associated with this Field Value." - }, - "language": { - "type": "string", - "nullable": true, - "description": "An ISO language-country string of the value." - }, - "assistant_sid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." + "format": "uri", + "nullable": true }, - "sid": { + "commands_callback_method": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A 34 character string that uniquely identifies this resource." + "nullable": true }, - "value": { + "sms_fallback_method": { "type": "string", - "nullable": true, - "description": "The Field Value itself." + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true }, - "url": { + "sms_fallback_url": { "type": "string", "format": "uri", "nullable": true }, - "synonym_of": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UC[0-9a-fA-F]{32}$", - "nullable": true, - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym." - } - } - }, - "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." - }, - "date_created": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was created" - }, - "date_updated": { + "sms_method": { "type": "string", - "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true }, - "assistant_sid": { + "sms_url": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the parent Assistant." + "format": "uri", + "nullable": true }, - "sid": { + "voice_fallback_method": { "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." + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true }, - "status": { + "voice_fallback_url": { "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" + "format": "uri", + "nullable": true }, - "unique_name": { + "voice_method": { "type": "string", - "nullable": true, - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "nullable": true }, - "url": { + "voice_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, - "description": "The date that this resource was created" + "nullable": true }, "date_updated": { "type": "string", "format": "date-time", - "nullable": true, - "description": "The date that this resource was last updated" - }, - "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" + "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true }, - "source_channel": { - "type": "string", - "nullable": true, - "description": "The communication channel where this end-user input came from" + "links": { + "type": "object", + "format": "uri-map", + "nullable": true } } }, - "preview.understand.assistant.task.sample": { + "preview.wireless.sim.usage": { "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": { + "sim_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." + "pattern": "^DE[0-9a-fA-F]{32}$", + "nullable": true }, - "language": { + "sim_unique_name": { "type": "string", - "nullable": true, - "description": "An ISO language-country string of the sample." + "nullable": true }, - "assistant_sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UA[0-9a-fA-F]{32}$", - "nullable": true, - "description": "The unique ID of the Assistant." + "pattern": "^AC[0-9a-fA-F]{32}$", + "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." + "period": { + "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." + "commands_usage": { + "nullable": true }, - "url": { - "type": "string", - "format": "uri", + "commands_costs": { "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" + "data_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" + "data_costs": { + "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true - }, - "data": { - "nullable": true, - "description": "The JSON style sheet object" } } - }, - "preview.understand.assistant.task": { - "type": "object", - "properties": { - "account_sid": { - "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 - } - } - } - } - }, - "info": { - "title": "Twilio - Preview", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.0.0" - }, - "openapi": "3.0.1", - "paths": { - "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "instance" - }, - "get": { - "description": "Fetch information about a specific Certificate credential in the Fleet.", - "tags": [ - "PreviewDeployedDevicesCertificate" - ], - "parameters": [ - { - "name": "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesCertificate" - }, - "delete": { - "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", - "tags": [ - "PreviewDeployedDevicesCertificate" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "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" - }, - "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" - }, - "examples": { - "update": { - "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesCertificate", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Certificates": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" - }, - "post": { - "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", - "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" - }, - "examples": { - "create": { - "value": { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesCertificate", - "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" - ] - }, - "examples": { - "create": { - "value": { - "CertificateData": "12345678abcdef", - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "certificates": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", - "key": "certificates", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "certificates": [ - { - "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "thumbprint": "1234567890", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", - "key": "certificates", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesCertificate" - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDeployment" - }, - "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" - }, - "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" - }, - "examples": { - "update": { - "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDeployment", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "friendly_name", - "SyncServiceSid": "sync_service_sid" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Deployments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" - }, - "post": { - "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", - "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" - }, - "examples": { - "create": { - "value": { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDeployment", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeploymentRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." - }, - "SyncServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment." - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "SyncServiceSid": "sync_service_sid" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Deployments belonging to the Fleet.", - "tags": [ - "PreviewDeployedDevicesDeployment" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "deployments": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", - "key": "deployments", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "deployments": [ - { - "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", - "key": "deployments", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesDeployment" - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesDevice" - }, - "delete": { - "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", - "tags": [ - "PreviewDeployedDevicesDevice" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesDevice" - }, - "post": { - "description": "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" - }, - "examples": { - "update": { - "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesDevice", - "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": "" - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "friendly_name", - "Identity": "identity" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Devices": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" - }, - "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" - }, - "examples": { - "create": { - "value": { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesDevice", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesDeviceRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." - }, - "Identity": { - "type": "string", - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." - }, - "DeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." - }, - "Enabled": { - "type": "boolean", - "description": "" - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Identity": "identity" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of 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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "devices": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", - "key": "devices", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "devices": [ - { - "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "enabled": true, - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "bob@twilio.com", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "date_authenticated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", - "key": "devices", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesDevice" - } - }, - "/DeployedDevices/Fleets/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "devices": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" - }, - "deployments": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" - }, - "certificates": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" - }, - "keys": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" - } - }, - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesFleet" - }, - "delete": { - "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", - "tags": [ - "PreviewDeployedDevicesFleet" - ], - "parameters": [ - { - "name": "Sid", - "in": "path", - "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteDeployedDevicesFleet" - }, - "post": { - "description": "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" - }, - "examples": { - "update": { - "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesFleet", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesFleetRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." - }, - "DefaultDeploymentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet." - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "friendly_name", - "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "devices": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" - }, - "deployments": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" - }, - "certificates": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" - }, - "keys": { - "mapping": { - "fleet_sid": "sid" - }, - "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" - } - }, - "pathType": "list" - }, - "post": { - "description": "Create a new Fleet for scoping of deployed devices within your account.", - "tags": [ - "PreviewDeployedDevicesFleet" - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet" - }, - "examples": { - "create": { - "value": { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" - } - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesFleet", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesFleetRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name" - } - } - } - } - } - } - }, - "get": { - "description": "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "fleets": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", - "key": "fleets", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "fleets": [ - { - "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", - "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", - "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", - "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" - } - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", - "key": "fleets", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesFleet" - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "instance" - }, - "get": { - "description": "Fetch information about a specific Key credential in the Fleet.", - "tags": [ - "PreviewDeployedDevicesKey" - ], - "parameters": [ - { - "name": "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchDeployedDevicesKey" - }, - "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" - }, - "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" - }, - "examples": { - "update": { - "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateDeployedDevicesKey", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateDeployedDevicesKeyRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." - } - } - }, - "examples": { - "update": { - "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - } - }, - "/DeployedDevices/Fleets/{FleetSid}/Keys": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Fleets/{Sid}", - "pathType": "list" - }, - "post": { - "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", - "tags": [ - "PreviewDeployedDevicesKey" - ], - "parameters": [ - { - "name": "FleetSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" - }, - "examples": { - "create": { - "value": { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateDeployedDevicesKey", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateDeployedDevicesKeyRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." - }, - "DeviceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." - } - } - }, - "examples": { - "create": { - "value": { - "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "FriendlyName": "friendly_name" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", - "tags": [ - "PreviewDeployedDevicesKey" - ], - "parameters": [ - { - "name": "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "keys": [], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", - "key": "keys", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" - } - } - }, - "readFull": { - "value": { - "keys": [ - { - "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "secret": null, - "date_created": "2016-07-30T20:00:00Z", - "date_updated": "2016-07-30T20:00:00Z", - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", - "key": "keys", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListDeployedDevicesKey" - } - }, - "/HostedNumbers/AuthorizationDocuments/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" - }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" - } - }, - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "address_sid": "AD11111111111111111111111111111111", - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchHostedNumbersAuthorizationDocument" - }, - "post": { - "description": "Updates a specific AuthorizationDocument.", - "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" - }, - "examples": { - "update": { - "value": { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateHostedNumbersAuthorizationDocument", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateHostedNumbersAuthorizationDocumentRequest", - "properties": { - "HostedNumberOrderSids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument." - }, - "Email": { - "type": "string", - "description": "Email that this AuthorizationDocument will be sent to for signing." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed" - }, - "Status": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses." - }, - "ContactTitle": { - "type": "string", - "description": "The title of the person authorized to sign the Authorization Document for this phone number." - }, - "ContactPhoneNumber": { - "type": "string", - "description": "The contact phone number of the person authorized to sign the Authorization Document." - } - } - }, - "examples": { - "update": { - "value": { - "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "HostedNumberOrderSids": [ - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" - ], - "Status": "signing", - "ContactTitle": "Mr.", - "ContactPhoneNumber": "+14155555555" - } - } - } - } - } - } - } - }, - "/HostedNumbers/AuthorizationDocuments": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "dependent_hosted_number_orders": { - "mapping": { - "signing_document_sid": "sid" - }, - "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" - } - }, - "pathType": "list" - }, - "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" - }, - "examples": { - "readEmpty": { - "value": "test+hosted@twilio.com" - } - } - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/authorization_document_enum_status" - }, - "examples": { - "readEmpty": { - "value": "signed" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListHostedNumbersAuthorizationDocumentResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" - }, - "items": [] - } - }, - "readFull": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" - }, - "items": [ - { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersAuthorizationDocument" - }, - "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" - }, - "examples": { - "create": { - "value": { - "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "links": { - "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" - }, - "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "signing", - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateHostedNumbersAuthorizationDocument", - "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" - ] - }, - "examples": { - "create": { - "value": { - "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "HostedNumberOrderSids": [ - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", - "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" - ], - "ContactTitle": "Mr.", - "ContactPhoneNumber": "+14155555555" - } - } - } - } - } - } - } - }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/AuthorizationDocuments/{Sid}", - "pathType": "list" - }, - "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", - "tags": [ - "PreviewHostedNumbersDependentHostedNumberOrder" - ], - "parameters": [ - { - "name": "SigningDocumentSid", - "in": "path", - "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Status", - "in": "query", - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" - }, - "examples": { - "readEmpty": { - "value": "completed" - } - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - }, - "examples": { - "readEmpty": { - "value": "+19193608000" - } - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - }, - "examples": { - "readEmpty": { - "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "example" - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "something123" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" - }, - "items": [] - } - }, - "readFull": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" - }, - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "1234", - "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "failure_reason": "", - "unique_name": "foobar", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersDependentHostedNumberOrder" - } - }, - "/HostedNumbers/HostedNumberOrders/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "5105", - "failure_reason": "", - "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "unique_name": "foobar", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchHostedNumbersHostedNumberOrder" - }, - "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" - }, - "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" - }, - "examples": { - "update": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test+hosted@twilio.com", - "extension": "1234", - "failure_reason": "", - "friendly_name": "new friendly name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "pending-loa", - "unique_name": "new unique name", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 1, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "UpdateHostedNumbersHostedNumberOrder", - "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." - } - } - }, - "examples": { - "update": { - "value": { - "FriendlyName": "new friendly name", - "UniqueName": "new unique name", - "Email": "test+hosted@twilio.com", - "CcEmails": [ - "test1@twilio.com", - "test2@twilio.com" - ], - "Status": "pending-loa", - "Extension": "1234", - "CallDelay": 15 - } - } - } - } - } - } - } - }, - "/HostedNumbers/HostedNumberOrders": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "pathType": "list" - }, - "get": { - "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", - "tags": [ - "PreviewHostedNumbersHostedNumberOrder" - ], - "parameters": [ - { - "name": "Status", - "in": "query", - "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", - "schema": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_status" - }, - "examples": { - "readEmpty": { - "value": "completed" - } - } - }, - { - "name": "PhoneNumber", - "in": "query", - "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", - "schema": { - "type": "string", - "format": "phone-number" - }, - "examples": { - "readEmpty": { - "value": "+19193608000" - } - } - }, - { - "name": "IncomingPhoneNumberSid", - "in": "query", - "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$" - }, - "examples": { - "readEmpty": { - "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" - } - } - }, - { - "name": "FriendlyName", - "in": "query", - "description": "A human readable description of this resource, up to 64 characters.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "example" - } - } - }, - { - "name": "UniqueName", - "in": "query", - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "something123" - } - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "ListHostedNumbersHostedNumberOrderResponse", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" - } - }, - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readEmpty": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" - }, - "items": [] - } - }, - "readFull": { - "value": { - "meta": { - "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", - "key": "items", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" - }, - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 15, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [ - "aaa@twilio.com", - "bbb@twilio.com" - ], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": "1234", - "failure_reason": "", - "friendly_name": "friendly_name", - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": "PX11111111111111111111111111111111", - "status": "received", - "unique_name": "foobar", - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": [ - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" - ], - "verification_code": "8794", - "verification_document_sid": null, - "verification_type": "phone-call" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListHostedNumbersHostedNumberOrder" - }, - "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" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": "AD11111111111111111111111111111111", - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": "test@twilio.com", - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": null, - "verification_type": "phone-call" - } - }, - "createWithoutOptionalLoaFields": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": null, - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": null, - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": null, - "verification_type": "phone-call" - } - }, - "createWithPhoneBillVerification": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "address_sid": null, - "call_delay": 0, - "capabilities": { - "sms": true, - "voice": false - }, - "cc_emails": [], - "date_created": "2017-03-28T20:06:39Z", - "date_updated": "2017-03-28T20:06:39Z", - "email": null, - "extension": null, - "failure_reason": "", - "friendly_name": null, - "incoming_phone_number_sid": "PN11111111111111111111111111111111", - "phone_number": "+14153608311", - "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "signing_document_sid": null, - "status": "received", - "unique_name": null, - "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_attempts": 0, - "verification_call_sids": null, - "verification_code": null, - "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "verification_type": "phone-bill" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateHostedNumbersHostedNumberOrder", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateHostedNumbersHostedNumberOrderRequest", - "properties": { - "PhoneNumber": { - "type": "string", - "format": "phone-number", - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" - }, - "SmsCapability": { - "type": "boolean", - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." - }, - "AccountSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." - }, - "FriendlyName": { - "type": "string", - "description": "A 64 character string that is a human readable text that describes this resource." - }, - "UniqueName": { - "type": "string", - "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." - }, - "CcEmails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." - }, - "SmsUrl": { - "type": "string", - "format": "uri", - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackUrl": { - "type": "string", - "format": "uri", - "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." - }, - "SmsFallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." - }, - "StatusCallbackUrl": { - "type": "string", - "format": "uri", - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." - }, - "StatusCallbackMethod": { - "type": "string", - "format": "http-method", - "enum": [ - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." - }, - "SmsApplicationSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." - }, - "AddressSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." - }, - "Email": { - "type": "string", - "description": "Optional. Email of the owner of this phone number that is being hosted." - }, - "VerificationType": { - "type": "string", - "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." - }, - "VerificationDocumentSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." - } - }, - "required": [ - "PhoneNumber", - "SmsCapability" - ] - }, - "examples": { - "create": { - "value": { - "AddressSid": "AD11111111111111111111111111111111", - "PhoneNumber": "+14153608311", - "SmsCapability": true, - "Email": "test@twilio.com" - } - }, - "createWithoutOptionalLoaFields": { - "value": { - "PhoneNumber": "+14153608311", - "SmsCapability": true - } - }, - "createWithPhoneBillVerification": { - "value": { - "PhoneNumber": "+14153608311", - "SmsCapability": true, - "VerificationType": "phone-bill", - "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } - } - }, - "/marketplace/AvailableAddOns/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "available_add_on_sid": "sid" - }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" - } - }, - "pathType": "instance" - }, - "get": { - "description": "Fetch an instance of an Add-on currently available to be installed.", - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "pricing_type": "per minute", - "configuration_schema": { - "type": "object", - "properties": { - "bad_words": { - "type": "boolean" - } - }, - "required": [ - "bad_words" - ] - }, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchMarketplaceAvailableAddOn" - } - }, - "/marketplace/AvailableAddOns": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "available_add_on_sid": "sid" - }, - "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" - } - }, - "pathType": "list" - }, - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readFull": { - "value": { - "available_add_ons": [ - { - "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "pricing_type": "per minute", - "configuration_schema": { - "type": "object", - "properties": { - "bad_words": { - "type": "boolean" - } - }, - "required": [ - "bad_words" - ] - }, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" - } - } - ], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "available_add_ons" - } - } - }, - "readEmpty": { - "value": { - "available_add_ons": [], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "available_add_ons" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListMarketplaceAvailableAddOn" - } - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension", - "pathType": "instance" - }, - "get": { - "description": "Fetch an instance of an Extension for the Available Add-on.", - "tags": [ - "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" - }, - "examples": { - "fetch": { - "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchMarketplaceAvailableAddOnExtension" - } - }, - "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/AvailableAddOns/{Sid}", - "className": "available_add_on_extension", - "pathType": "list" - }, - "get": { - "description": "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readFull": { - "value": { - "extensions": [ - { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" - } - } - }, - "readEmpty": { - "value": { - "extensions": [], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListMarketplaceAvailableAddOnExtension" - } - }, - "/marketplace/InstalledAddOns": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" - }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" - } - }, - "pathType": "list" - }, - "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" - }, - "examples": { - "create": { - "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription_1", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateMarketplaceInstalledAddOn", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateMarketplaceInstalledAddOnRequest", - "properties": { - "AvailableAddOnSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "description": "The SID of the AvaliableAddOn to install." - }, - "AcceptTermsOfService": { - "type": "boolean", - "description": "Whether the Terms of Service were accepted." - }, - "Configuration": { - "description": "The JSON object that represents the configuration of the new Add-on being installed." - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." - } - }, - "required": [ - "AvailableAddOnSid", - "AcceptTermsOfService" - ] - }, - "examples": { - "create": { - "value": { - "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "AcceptTermsOfService": true, - "Configuration": "{\"bad_words\": true}", - "UniqueName": "voicebase_high_accuracy_transcription_1" - } - } - } - } - } - } - }, - "get": { - "description": "Retrieve a list of Add-ons currently installed on this Account.", - "tags": [ - "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": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - }, - "examples": { - "readFull": { - "value": { - "installed_add_ons": [ - { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - ], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "installed_add_ons" - } - } - }, - "readEmpty": { - "value": { - "installed_add_ons": [], - "meta": { - "page": 0, - "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", - "next_page_url": null, - "key": "installed_add_ons" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListMarketplaceInstalledAddOn" } + } + }, + "info": { + "title": "Twilio - Preview", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" }, - "/marketplace/InstalledAddOns/{Sid}": { + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.0" + }, + "openapi": "3.0.1", + "paths": { + "/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7218,68 +1917,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "extensions": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" - }, - "usage": { - "mapping": { - "installed_add_on_sid": "sid" - }, - "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" - } - }, + "parent": "/Fleets/{Sid}", "pathType": "instance" }, - "delete": { - "description": "Remove an Add-on installation from your account", + "get": { + "description": "Fetch information about a specific Certificate credential in the Fleet.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewDeployedDevicesCertificate" ], "parameters": [ { - "name": "Sid", + "name": "FleetSid", "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}$" + "type": "string" }, "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteMarketplaceInstalledAddOn" - }, - "get": { - "description": "Fetch an instance of an Add-on currently installed on this Account.", - "tags": [ - "PreviewMarketplaceInstalledAddOn" - ], - "parameters": [ + }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn resource to fetch.", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } @@ -7289,26 +1953,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" }, "examples": { "fetch": { "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7322,58 +1980,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOn" + "operationId": "FetchDeployedDevicesCertificate" }, - "post": { - "description": "Update an Add-on installation for the Account specified.", + "delete": { + "description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ - "PreviewMarketplaceInstalledAddOn" + "PreviewDeployedDevicesCertificate" ], "parameters": [ + { + "name": "FleetSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn resource to update.", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$" + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on" - }, - "examples": { - "update": { - "value": { - "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "VoiceBase High Accuracy Transcription", - "description": "Automatic Transcription and Keyword Extract...", - "configuration": { - "bad_words": true - }, - "unique_name": "voicebase_high_accuracy_transcription_2", - "date_created": "2016-04-07T23:52:28Z", - "date_updated": "2016-04-07T23:52:28Z", - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", - "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -7381,76 +2020,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOn", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateMarketplaceInstalledAddOnRequest", - "properties": { - "Configuration": { - "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" - }, - "UniqueName": { - "type": "string", - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." - } - } - }, - "examples": { - "update": { - "value": { - "Configuration": "{\"bad_words\": true}", - "UniqueName": "voicebase_high_accuracy_transcription_2" - } - } - } - } - } - } - } - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension", - "pathType": "instance" + "operationId": "DeleteDeployedDevicesCertificate" }, - "get": { - "description": "Fetch an instance of an Extension for the Installed Add-on.", + "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": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesCertificate" ], "parameters": [ { - "name": "InstalledAddOnSid", + "name": "FleetSid", "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}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "The SID of the InstalledAddOn Extension resource to fetch.", + "description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$" + "pattern": "^CY[0-9a-fA-F]{32}$" }, "required": true } @@ -7460,18 +2055,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" }, "examples": { - "fetch": { + "update": { "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": true, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7485,62 +2082,93 @@ "accountSid_authToken": [] } ], - "operationId": "FetchMarketplaceInstalledAddOnExtension" + "operationId": "UpdateDeployedDevicesCertificate", + "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." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } + } + }, + "/DeployedDevices/Fleets/{FleetSid}/Certificates": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Fleets/{Sid}", + "pathType": "list" }, "post": { - "description": "Update an Extension for an Add-on installation.", + "description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesCertificate" ], "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", + "name": "FleetSid", "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}$" + "type": "string" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" }, "examples": { - "update": { + "create": { "value": { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": false, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -7548,65 +2176,72 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateMarketplaceInstalledAddOnExtension", + "operationId": "CreateDeployedDevicesCertificate", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", + "title": "CreateDeployedDevicesCertificateRequest", "properties": { - "Enabled": { - "type": "boolean", - "description": "Whether the Extension should be invoked." + "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": [ - "Enabled" + "CertificateData" ] }, "examples": { - "update": { + "create": { "value": { - "Enabled": false + "CertificateData": "12345678abcdef", + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } } } } - } - }, - "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/InstalledAddOns/{Sid}", - "className": "installed_add_on_extension", - "pathType": "list" }, "get": { - "description": "Retrieve a list of Extensions for the Installed Add-on.", + "description": "Retrieve a list of all Certificate credentials belonging to the Fleet.", "tags": [ - "PreviewMarketplaceInstalledAddOnExtension" + "PreviewDeployedDevicesCertificate" ], "parameters": [ { - "name": "InstalledAddOnSid", + "name": "FleetSid", "in": "path", - "description": "The SID of the InstalledAddOn resource with the extensions to read.", + "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": "^XE[0-9a-fA-F]{32}$" - }, - "required": true + "pattern": "^TH[0-9a-fA-F]{32}$" + } }, { "name": "PageSize", @@ -7642,12 +2277,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListMarketplaceInstalledAddOnExtensionResponse", + "title": "ListDeployedDevicesCertificateResponse", "properties": { - "extensions": { + "certificates": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } }, "meta": { @@ -7685,41 +2320,43 @@ } }, "examples": { - "readFull": { + "readEmpty": { "value": { - "extensions": [ - { - "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "Incoming Voice Call", - "product_name": "Programmable Voice", - "unique_name": "voice-incoming", - "enabled": true, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], + "certificates": [], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } }, - "readEmpty": { + "readFull": { "value": { - "extensions": [], + "certificates": [ + { + "sid": "CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "thumbprint": "1234567890", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0", + "key": "certificates", + "next_page_url": null, "page": 0, "page_size": 50, - "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", - "next_page_url": null, - "key": "extensions" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0" } } } @@ -7734,10 +2371,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListMarketplaceInstalledAddOnExtension" + "operationId": "ListDeployedDevicesCertificate" } }, - "/Sync/Services/{ServiceSid}/Documents/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -7746,42 +2383,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "document_permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Deployment in the Fleet.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -7791,24 +2419,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { "fetch": { "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7822,32 +2445,32 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocument" + "operationId": "FetchDeployedDevicesDeployment" }, "delete": { - "description": "", + "description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true } @@ -7862,42 +2485,34 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocument" + "operationId": "DeleteDeployedDevicesDeployment" }, "post": { - "description": "", + "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": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -7905,24 +2520,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { "update": { "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -7936,27 +2546,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocument", + "operationId": "UpdateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentRequest", + "title": "UpdateDeployedDevicesDeploymentRequest", "properties": { - "Data": { - "description": "" + "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." } - }, - "required": [ - "Data" - ] + } }, "examples": { "update": { "value": { - "Data": "{}", - "UniqueName": "unique_name" + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" } } } @@ -7965,7 +2580,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Documents": { + "/DeployedDevices/Fleets/{FleetSid}/Deployments": { "servers": [ { "url": "https://preview.twilio.com" @@ -7974,33 +2589,21 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "document_permissions": { - "mapping": { - "service_sid": "service_sid", - "document_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", + "parent": "/Fleets/{Sid}", "pathType": "list" }, "post": { - "description": "", + "description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -8010,24 +2613,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" }, "examples": { "create": { "value": { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8041,28 +2639,32 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncDocument", + "operationId": "CreateDeployedDevicesDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncDocumentRequest", + "title": "CreateDeployedDevicesDeploymentRequest", "properties": { - "UniqueName": { + "FriendlyName": { "type": "string", - "description": "" + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long." }, - "Data": { - "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." } } }, "examples": { "create": { "value": { - "Data": "{}", - "UniqueName": "unique_name" + "FriendlyName": "friendly_name", + "SyncServiceSid": "sync_service_sid" } } } @@ -8071,20 +2673,17 @@ } }, "get": { - "description": "", + "description": "Retrieve a list of all Deployments belonging to the Fleet.", "tags": [ - "PreviewSyncDocument" + "PreviewDeployedDevicesDeployment" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, @@ -8122,12 +2721,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncDocumentResponse", + "title": "ListDeployedDevicesDeploymentResponse", "properties": { - "documents": { + "deployments": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } }, "meta": { @@ -8167,45 +2766,40 @@ "examples": { "readEmpty": { "value": { - "documents": [], + "deployments": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", - "key": "documents", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } }, "readFull": { "value": { - "documents": [ + "deployments": [ { + "sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "links": { - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - } + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sync_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", - "key": "documents", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0", + "key": "deployments", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0" } } } @@ -8220,10 +2814,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocument" + "operationId": "ListDeployedDevicesDeployment" } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { + "/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -8232,41 +2826,28 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions", + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "Fetch a specific Sync Document Permission.", + "description": "Fetch information about a specific Device in the Fleet.", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "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": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -8278,19 +2859,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" }, "examples": { "fetch": { "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8304,39 +2889,27 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncDocumentPermission" + "operationId": "FetchDeployedDevicesDevice" }, "delete": { - "description": "Delete a specific Sync Document Permission.", + "description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.", "tags": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", + "name": "FleetSid", "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": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -8353,39 +2926,27 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncDocumentPermission" + "operationId": "DeleteDeployedDevicesDevice" }, "post": { - "description": "Update an identity's access to a specific Sync Document.", + "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": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "DocumentSid", + "name": "FleetSid", "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 human user associated with an FPA token, assigned by the developer.", + "description": "Provides a 34 character string that uniquely identifies the requested Device resource.", "schema": { "type": "string" }, @@ -8397,19 +2958,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" }, "examples": { "update": { "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8423,39 +2988,40 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncDocumentPermission", + "operationId": "UpdateDeployedDevicesDevice", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncDocumentPermissionRequest", + "title": "UpdateDeployedDevicesDeviceRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Document." + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can update the Sync Document." + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." }, - "Manage": { + "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": "Boolean flag specifying whether the identity can delete the Sync Document." + "description": "" } - }, - "required": [ - "Read", - "Write", - "Manage" - ] + } }, "examples": { "update": { "value": { - "Read": "true", - "Write": "true", - "Manage": "true" + "FriendlyName": "friendly_name", + "Identity": "identity" } } } @@ -8464,7 +3030,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { + "/DeployedDevices/Fleets/{FleetSid}/Devices": { "servers": [ { "url": "https://preview.twilio.com" @@ -8473,37 +3039,132 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Documents/{Sid}", - "mountName": "document_permissions", + "parent": "/Fleets/{Sid}", "pathType": "list" }, - "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Document.", + "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": [ - "PreviewSyncDocumentPermission" + "PreviewDeployedDevicesDevice" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true - }, + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" + }, + "examples": { + "create": { + "value": { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "enabled": true, + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ { - "name": "DocumentSid", + "accountSid_authToken": [] + } + ], + "operationId": "CreateDeployedDevicesDevice", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateDeployedDevicesDeviceRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long." + }, + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long." + }, + "Identity": { + "type": "string", + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long." + }, + "DeploymentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with." + }, + "Enabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "UniqueName": "unique_name", + "Identity": "identity" + } + } + } + } + } + } + }, + "get": { + "description": "Retrieve a list of all Devices belonging to the Fleet.", + "tags": [ + "PreviewDeployedDevicesDevice" + ], + "parameters": [ + { + "name": "FleetSid", "in": "path", - "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "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", @@ -8538,12 +3199,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncDocumentPermissionResponse", + "title": "ListDeployedDevicesDeviceResponse", "properties": { - "permissions": { + "devices": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } }, "meta": { @@ -8583,40 +3244,44 @@ "examples": { "readEmpty": { "value": { - "permissions": [], + "devices": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" } } }, "readFull": { "value": { - "permissions": [ + "devices": [ { + "sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "enabled": true, + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "bob@twilio.com", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "date_authenticated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0", + "key": "devices", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0" } } } @@ -8631,10 +3296,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncDocumentPermission" + "operationId": "ListDeployedDevicesDevice" } }, - "/Sync/Services/{Sid}": { + "/DeployedDevices/Fleets/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -8644,42 +3309,45 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "documents": { + "devices": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Documents" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" }, - "sync_lists": { + "deployments": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Lists" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" }, - "sync_maps": { + "certificates": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } }, "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Fleet in your account.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -8689,25 +3357,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, "examples": { "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": false + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } } } @@ -8721,23 +3389,20 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncService" + "operationId": "FetchDeployedDevicesFleet" }, "delete": { - "description": "", + "description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -8752,23 +3417,20 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncService" + "operationId": "DeleteDeployedDevicesFleet" }, "post": { - "description": "", + "description": "Update the friendly name property of a specific Fleet in your account.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesFleet" ], "parameters": [ { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -8778,25 +3440,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, "examples": { "update": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": true + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } } } @@ -8810,30 +3472,24 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncService", + "operationId": "UpdateDeployedDevicesFleet", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncServiceRequest", + "title": "UpdateDeployedDevicesFleetRequest", "properties": { - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, "FriendlyName": { "type": "string", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." }, - "AclEnabled": { - "type": "boolean", - "description": "" + "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." } } }, @@ -8841,8 +3497,7 @@ "update": { "value": { "FriendlyName": "friendly_name", - "WebhookUrl": "http://www.example.com", - "AclEnabled": true + "DefaultDeploymentSid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -8851,7 +3506,7 @@ } } }, - "/Sync/Services": { + "/DeployedDevices/Fleets": { "servers": [ { "url": "https://preview.twilio.com" @@ -8861,56 +3516,62 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "documents": { + "devices": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Documents" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Devices" }, - "sync_lists": { + "deployments": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Lists" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Deployments" }, - "sync_maps": { + "certificates": { "mapping": { - "service_sid": "sid" + "fleet_sid": "sid" }, - "resource_url": "/Sync/Services/{service_sid}/Maps" + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Certificates" + }, + "keys": { + "mapping": { + "fleet_sid": "sid" + }, + "resource_url": "/DeployedDevices/Fleets/{fleet_sid}/Keys" } }, "pathType": "list" }, "post": { - "description": "", + "description": "Create a new Fleet for scoping of deployed devices within your account.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesFleet" ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" }, "examples": { "create": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": true + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } } } } @@ -8924,39 +3585,24 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncService", + "operationId": "CreateDeployedDevicesFleet", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncServiceRequest", + "title": "CreateDeployedDevicesFleetRequest", "properties": { "FriendlyName": { "type": "string", - "description": "" - }, - "WebhookUrl": { - "type": "string", - "format": "uri", - "description": "" - }, - "ReachabilityWebhooksEnabled": { - "type": "boolean", - "description": "" - }, - "AclEnabled": { - "type": "boolean", - "description": "" + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long." } } }, "examples": { "create": { "value": { - "FriendlyName": "friendly_name", - "WebhookUrl": "http://www.example.com", - "AclEnabled": true + "FriendlyName": "friendly_name" } } } @@ -8965,9 +3611,9 @@ } }, "get": { - "description": "", + "description": "Retrieve a list of all Fleets belonging to your account.", "tags": [ - "PreviewSyncService" + "PreviewDeployedDevicesFleet" ], "parameters": [ { @@ -9004,12 +3650,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncServiceResponse", + "title": "ListDeployedDevicesFleetResponse", "properties": { - "services": { + "fleets": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service" + "$ref": "#/components/schemas/preview.deployed_devices.fleet" } }, "meta": { @@ -9049,47 +3695,47 @@ "examples": { "readEmpty": { "value": { + "fleets": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", - "key": "services", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" - }, - "services": [] + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + } } }, "readFull": { "value": { + "fleets": [ + { + "sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "default_deployment_sid": "DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "devices": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices", + "deployments": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments", + "certificates": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates", + "keys": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys" + } + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", - "key": "services", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0", + "key": "fleets", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" - }, - "services": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "links": { - "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", - "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", - "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" - }, - "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "webhook_url": "http://www.example.com", - "reachability_webhooks_enabled": false, - "acl_enabled": false - } - ] + "url": "https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0" + } } } } @@ -9103,10 +3749,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncService" + "operationId": "ListDeployedDevicesFleet" } }, - "/Sync/Services/{ServiceSid}/Lists/{Sid}": { + "/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -9115,50 +3761,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "sync_list_items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, - "sync_list_permissions": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists", + "parent": "/Fleets/{Sid}", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch information about a specific Key credential in the Fleet.", "tags": [ - "PreviewSyncSyncList" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { "name": "Sid", "in": "path", - "description": "", + "description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true } @@ -9168,24 +3797,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" }, "examples": { "fetch": { "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9199,39 +3824,101 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncList" + "operationId": "FetchDeployedDevicesKey" }, "delete": { - "description": "", + "description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.", "tags": [ - "PreviewSyncSyncList" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "ServiceSid", + "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": "^IS[0-9a-fA-F]{32}$" + "pattern": "^KY[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "name": "Sid", + "accountSid_authToken": [] + } + ], + "operationId": "DeleteDeployedDevicesKey" + }, + "post": { + "description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.", + "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." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" + }, + "examples": { + "update": { + "value": { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -9239,10 +3926,41 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncList" + "operationId": "UpdateDeployedDevicesKey", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateDeployedDevicesKeyRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." + } + } + }, + "examples": { + "update": { + "value": { + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Lists": { + "/DeployedDevices/Fleets/{FleetSid}/Keys": { "servers": [ { "url": "https://preview.twilio.com" @@ -9251,41 +3969,21 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "sync_list_items": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" - }, - "sync_list_permissions": { - "mapping": { - "service_sid": "service_sid", - "list_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_lists", + "parent": "/Fleets/{Sid}", "pathType": "list" }, "post": { - "description": "", + "description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.", "tags": [ - "PreviewSyncSyncList" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "ServiceSid", + "name": "FleetSid", "in": "path", "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -9295,24 +3993,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" }, "examples": { "create": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": null, + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9326,24 +4020,32 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncList", + "operationId": "CreateDeployedDevicesKey", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListRequest", + "title": "CreateDeployedDevicesKeyRequest", "properties": { - "UniqueName": { + "FriendlyName": { "type": "string", - "description": "" + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long." + }, + "DeviceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential." } } }, "examples": { "create": { "value": { - "UniqueName": "unique_name" + "DeviceSid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "FriendlyName": "friendly_name" } } } @@ -9352,22 +4054,30 @@ } }, "get": { - "description": "", + "description": "Retrieve a list of all Keys credentials belonging to the Fleet.", "tags": [ - "PreviewSyncSyncList" + "PreviewDeployedDevicesKey" ], "parameters": [ { - "name": "ServiceSid", + "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": "^IS[0-9a-fA-F]{32}$" - }, - "required": true + "pattern": "^TH[0-9a-fA-F]{32}$" + } }, { "name": "PageSize", @@ -9403,12 +4113,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListResponse", + "title": "ListDeployedDevicesKeyResponse", "properties": { - "lists": { + "keys": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list" + "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } }, "meta": { @@ -9448,45 +4158,41 @@ "examples": { "readEmpty": { "value": { - "lists": [], + "keys": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", - "key": "lists", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" } } }, "readFull": { "value": { - "lists": [ + "keys": [ { + "sid": "KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "friendly_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "fleet_sid": "FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "device_sid": "THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "secret": null, + "date_created": "2016-07-30T20:00:00Z", + "date_updated": "2016-07-30T20:00:00Z", + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", - "key": "lists", + "first_page_url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0", + "key": "keys", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" + "url": "https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0" } } } @@ -9501,10 +4207,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncList" + "operationId": "ListDeployedDevicesKey" } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "/HostedNumbers/AuthorizationDocuments/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -9513,182 +4219,33 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items", - "pathType": "instance" - }, - "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": "Index", - "in": "path", - "description": "", - "schema": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncSyncListItem" - }, - "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" + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" }, - "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." + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncListItem" + "pathType": "instance" }, - "post": { - "description": "", + "get": { + "description": "Fetch a specific AuthorizationDocument.", "tags": [ - "PreviewSyncSyncListItem" + "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Index", - "in": "path", - "description": "", - "schema": { - "type": "integer" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true - }, - { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", - "schema": { - "type": "string" - } } ], "responses": { @@ -9696,21 +4253,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { - "update": { + "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + "address_sid": "AD11111111111111111111111111111111", + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -9724,101 +4285,57 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListItem", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncSyncListItemRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - }, - "examples": { - "update": { - "value": { - "Data": "{}" - } - } - } - } - } - } - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_items", - "pathType": "list" + "operationId": "FetchHostedNumbersAuthorizationDocument" }, "post": { - "description": "", + "description": "Updates a specific AuthorizationDocument.", "tags": [ - "PreviewSyncSyncListItem" + "PreviewHostedNumbersAuthorizationDocument" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this AuthorizationDocument.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ListSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^PX[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { - "create": { + "update": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -9826,107 +4343,133 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncListItem", + "operationId": "UpdateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncListItemRequest", + "title": "UpdateHostedNumbersAuthorizationDocumentRequest", "properties": { - "Data": { - "description": "" + "HostedNumberOrderSids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform." + }, + "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." } - }, - "required": [ - "Data" - ] + } }, "examples": { - "create": { + "update": { "value": { - "Data": "{}" + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "Status": "signing", + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" } } } } } } - }, - "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" + } + }, + "/HostedNumbers/AuthorizationDocuments": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "dependent_hosted_number_orders": { + "mapping": { + "signing_document_sid": "sid" }, - "examples": { - "readEmpty": { - "value": "asc" - }, - "readFull": { - "value": "asc" - } - } - }, + "resource_url": "/HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders" + } + }, + "pathType": "list" + }, + "get": { + "description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], + "parameters": [ { - "name": "From", + "name": "Email", "in": "query", - "description": "", + "description": "Email that this AuthorizationDocument will be sent to for signing.", "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { - "value": "from" - }, - "readFull": { - "value": "from" + "value": "test+hosted@twilio.com" } } }, { - "name": "Bounds", + "name": "Status", "in": "query", - "description": "", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/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/sync_list_item_enum_query_from_bound_type" + "$ref": "#/components/schemas/authorization_document_enum_status" }, "examples": { "readEmpty": { - "value": "inclusive" - }, - "readFull": { - "value": "inclusive" + "value": "signed" } } }, @@ -9964,12 +4507,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListItemResponse", + "title": "ListHostedNumbersAuthorizationDocumentResponse", "properties": { "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" } }, "meta": { @@ -10009,252 +4552,97 @@ "examples": { "readEmpty": { "value": { - "items": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0" + }, + "items": [] } }, "readFull": { "value": { - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "index": 100, - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" - } - ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0", "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" - } - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListSyncSyncListItem" - } - }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0" + }, + "items": [ + { + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] } } } } }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncSyncListPermission" - }, - "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" - }, - "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 - }, - { - "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 + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] } ], + "operationId": "ListHostedNumbersAuthorizationDocument" + }, + "post": { + "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", + "tags": [ + "PreviewHostedNumbersAuthorizationDocument" + ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" }, "examples": { - "update": { + "create": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "links": { + "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders" + }, + "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "status": "signing", + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -10262,39 +4650,71 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncListPermission", + "operationId": "CreateHostedNumbersAuthorizationDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncListPermissionRequest", + "title": "CreateHostedNumbersAuthorizationDocumentRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync List." + "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." }, - "Write": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + "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." }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync List." + "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": [ - "Read", - "Write", - "Manage" + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" ] }, "examples": { - "update": { + "create": { "value": { - "Read": "true", - "Write": "true", - "Manage": "true" + "AddressSid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "HostedNumberOrderSids": [ + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", + "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" + ], + "ContactTitle": "Mr.", + "ContactPhoneNumber": "+14155555555" } } } @@ -10303,7 +4723,7 @@ } } }, - "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { "servers": [ { "url": "https://preview.twilio.com" @@ -10312,36 +4732,108 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Lists/{Sid}", - "mountName": "sync_list_permissions", + "parent": "/AuthorizationDocuments/{Sid}", "pathType": "list" }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync List.", + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", "tags": [ - "PreviewSyncSyncListPermission" + "PreviewHostedNumbersDependentHostedNumberOrder" ], "parameters": [ { - "name": "ServiceSid", + "name": "SigningDocumentSid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^PX[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": "Status", + "in": "query", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/dependent_hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$" + }, + "examples": { + "readEmpty": { + "value": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", "schema": { "type": "string" }, - "required": true + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } }, { "name": "PageSize", @@ -10377,12 +4869,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncListPermissionResponse", + "title": "ListHostedNumbersDependentHostedNumberOrderResponse", "properties": { - "permissions": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order" } }, "meta": { @@ -10422,41 +4914,64 @@ "examples": { "readEmpty": { "value": { - "permissions": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" + }, + "items": [] } }, "readFull": { "value": { - "permissions": [ + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "failure_reason": "", + "unique_name": "foobar", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" - } + ] } } } @@ -10470,10 +4985,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncListPermission" + "operationId": "ListHostedNumbersDependentHostedNumberOrder" } }, - "/Sync/Services/{ServiceSid}/Maps/{Sid}": { + "/HostedNumbers/HostedNumberOrders/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -10482,50 +4997,23 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "dependentProperties": { - "sync_map_items": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" - }, - "sync_map_permissions": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific HostedNumberOrder.", "tags": [ - "PreviewSyncSyncMap" + "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -10535,24 +5023,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "5105", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" } } } @@ -10566,32 +5073,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMap" + "operationId": "FetchHostedNumbersHostedNumberOrder" }, "delete": { - "description": "", + "description": "Cancel the HostedNumberOrder (only available when the status is in `received`).", "tags": [ - "PreviewSyncSyncMap" + "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Sid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } @@ -10606,86 +5104,75 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteSyncSyncMap" - } - }, - "/Sync/Services/{ServiceSid}/Maps": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "dependentProperties": { - "sync_map_items": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" - }, - "sync_map_permissions": { - "mapping": { - "service_sid": "service_sid", - "map_sid": "sid" - }, - "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" - } - }, - "parent": "/Services/{Sid}", - "mountName": "sync_maps", - "pathType": "list" + "operationId": "DeleteHostedNumbersHostedNumberOrder" }, "post": { - "description": "", + "description": "Updates a specific HostedNumberOrder.", "tags": [ - "PreviewSyncSyncMap" + "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { - "name": "ServiceSid", + "name": "Sid", "in": "path", - "description": "", + "description": "A 34 character string that uniquely identifies this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^HR[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" }, "examples": { - "create": { + "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "cc_emails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test+hosted@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "new friendly name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "pending-loa", + "unique_name": "new unique name", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 1, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -10693,48 +5180,183 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMap", + "operationId": "UpdateHostedNumbersHostedNumberOrder", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateSyncSyncMapRequest", + "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": "" + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "Email": { + "type": "string", + "description": "Email of the owner of this phone number that is being hosted." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to." + }, + "Status": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status", + "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill." + }, + "VerificationCode": { + "type": "string", + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + }, + "Extension": { + "type": "string", + "description": "Digits to dial after connecting the verification call." + }, + "CallDelay": { + "type": "integer", + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0." } } }, "examples": { - "create": { + "update": { "value": { - "UniqueName": "unique_name" + "FriendlyName": "new friendly name", + "UniqueName": "new unique name", + "Email": "test+hosted@twilio.com", + "CcEmails": [ + "test1@twilio.com", + "test2@twilio.com" + ], + "Status": "pending-loa", + "Extension": "1234", + "CallDelay": 15 } } } } } } + } + }, + "/HostedNumbers/HostedNumberOrders": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.", "tags": [ - "PreviewSyncSyncMap" + "PreviewHostedNumbersHostedNumberOrder" ], "parameters": [ { - "name": "ServiceSid", - "in": "path", - "description": "", + "name": "Status", + "in": "query", + "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", + "schema": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_status" + }, + "examples": { + "readEmpty": { + "value": "completed" + } + } + }, + { + "name": "PhoneNumber", + "in": "query", + "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", + "schema": { + "type": "string", + "format": "phone-number" + }, + "examples": { + "readEmpty": { + "value": "+19193608000" + } + } + }, + { + "name": "IncomingPhoneNumberSid", + "in": "query", + "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^PN[0-9a-fA-F]{32}$" }, - "required": true + "examples": { + "readEmpty": { + "value": "PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" + } + } + }, + { + "name": "FriendlyName", + "in": "query", + "description": "A human readable description of this resource, up to 64 characters.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "example" + } + } + }, + { + "name": "UniqueName", + "in": "query", + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, + "examples": { + "readEmpty": { + "value": "something123" + } + } }, { "name": "PageSize", @@ -10770,12 +5392,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapResponse", + "title": "ListHostedNumbersHostedNumberOrderResponse", "properties": { - "maps": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map" + "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } }, "meta": { @@ -10815,52 +5437,187 @@ "examples": { "readEmpty": { "value": { - "maps": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", - "key": "maps", + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0", + "key": "items", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" - } + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0" + }, + "items": [] + } + }, + "readFull": { + "value": { + "meta": { + "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0" + }, + "items": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 15, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [ + "aaa@twilio.com", + "bbb@twilio.com" + ], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": "1234", + "failure_reason": "", + "friendly_name": "friendly_name", + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": "PX11111111111111111111111111111111", + "status": "received", + "unique_name": "foobar", + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": [ + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" + ], + "verification_code": "8794", + "verification_document_sid": null, + "verification_type": "phone-call" + } + ] + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListHostedNumbersHostedNumberOrder" + }, + "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" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": "AD11111111111111111111111111111111", + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": "test@twilio.com", + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": null, + "verification_type": "phone-call" } }, - "readFull": { + "createWithPhoneBillVerification": { "value": { - "maps": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", - "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" - }, - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ], - "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", - "key": "maps", - "next_page_url": null, - "page": 0, - "page_size": 50, - "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" - } + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "address_sid": null, + "call_delay": 0, + "capabilities": { + "sms": true, + "voice": false + }, + "cc_emails": [], + "date_created": "2017-03-28T20:06:39Z", + "date_updated": "2017-03-28T20:06:39Z", + "email": null, + "extension": null, + "failure_reason": "", + "friendly_name": null, + "incoming_phone_number_sid": "PN11111111111111111111111111111111", + "phone_number": "+14153608311", + "sid": "HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "signing_document_sid": null, + "status": "received", + "unique_name": null, + "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_attempts": 0, + "verification_call_sids": null, + "verification_code": null, + "verification_document_sid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verification_type": "phone-bill" } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -10868,10 +5625,165 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMap" + "operationId": "CreateHostedNumbersHostedNumberOrder", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateHostedNumbersHostedNumberOrderRequest", + "properties": { + "PhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format" + }, + "SmsCapability": { + "type": "boolean", + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform." + }, + "AccountSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to." + }, + "FriendlyName": { + "type": "string", + "description": "A 64 character string that is a human readable text that describes this resource." + }, + "UniqueName": { + "type": "string", + "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID." + }, + "CcEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to." + }, + "SmsUrl": { + "type": "string", + "format": "uri", + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackUrl": { + "type": "string", + "format": "uri", + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource." + }, + "SmsFallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource." + }, + "StatusCallbackUrl": { + "type": "string", + "format": "uri", + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource." + }, + "StatusCallbackMethod": { + "type": "string", + "format": "http-method", + "enum": [ + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource." + }, + "SmsApplicationSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application." + }, + "AddressSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number." + }, + "Email": { + "type": "string", + "description": "Optional. Email of the owner of this phone number that is being hosted." + }, + "VerificationType": { + "type": "string", + "$ref": "#/components/schemas/hosted_number_order_enum_verification_type", + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill." + }, + "VerificationDocumentSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill." + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ] + }, + "examples": { + "create": { + "value": { + "AddressSid": "AD11111111111111111111111111111111", + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "Email": "test@twilio.com" + } + }, + "createWithoutOptionalLoaFields": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true + } + }, + "createWithPhoneBillVerification": { + "value": { + "PhoneNumber": "+14153608311", + "SmsCapability": true, + "VerificationType": "phone-bill", + "VerificationDocumentSid": "RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + } } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "/marketplace/AvailableAddOns/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -10880,43 +5792,31 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items", + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" + }, + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" + } + }, "pathType": "instance" }, "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 - }, + "description": "Fetch an instance of an Add-on currently available to be installed.", + "tags": [ + "PreviewMarketplaceAvailableAddOn" + ], + "parameters": [ { - "name": "Key", + "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true } @@ -10926,21 +5826,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.marketplace.available_add_on" }, "examples": { "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } } } } @@ -10954,105 +5863,57 @@ "accountSid_authToken": [] } ], - "operationId": "FetchSyncSyncMapItem" - }, - "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" + "operationId": "FetchMarketplaceAvailableAddOn" + } + }, + "/marketplace/AvailableAddOns": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "available_add_on_sid": "sid" }, - "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." + "resource_url": "/marketplace/AvailableAddOns/{available_add_on_sid}/Extensions" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncMapItem" + "pathType": "list" }, - "post": { - "description": "", + "get": { + "description": "Retrieve a list of Add-ons currently available to be installed.", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewMarketplaceAvailableAddOn" ], "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": "", + "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 + "type": "integer", + "minimum": 1, + "maximum": 1000 + } }, { - "name": "Key", - "in": "path", - "description": "", + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", "schema": { - "type": "string" - }, - "required": true + "type": "integer", + "minimum": 0 + } }, { - "name": "If-Match", - "in": "header", - "description": "The If-Match HTTP request header", + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" } @@ -11063,21 +5924,98 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "type": "object", + "title": "ListMarketplaceAvailableAddOnResponse", + "properties": { + "available_add_ons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.marketplace.available_add_on" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } }, "examples": { - "update": { + "readFull": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "available_add_ons": [ + { + "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "pricing_type": "per minute", + "configuration_schema": { + "type": "object", + "properties": { + "bad_words": { + "type": "boolean" + } + }, + "required": [ + "bad_words" + ] + }, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions" + } + } + ], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" + } + } + }, + "readEmpty": { + "value": { + "available_add_ons": [], + "meta": { + "page": 0, + "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "previous_page_url": null, + "url": "https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "available_add_ons" + } } } } @@ -11091,35 +6029,10 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapItem", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateSyncSyncMapItemRequest", - "properties": { - "Data": { - "description": "" - } - }, - "required": [ - "Data" - ] - }, - "examples": { - "update": { - "value": { - "Data": "{}" - } - } - } - } - } - } + "operationId": "ListMarketplaceAvailableAddOn" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -11128,64 +6041,63 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_items", - "pathType": "list" + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "instance" }, - "post": { - "description": "", + "get": { + "description": "Fetch an instance of an Extension for the Available Add-on.", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewMarketplaceAvailableAddOnExtension" ], "parameters": [ { - "name": "ServiceSid", + "name": "AvailableAddOnSid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource with the extension to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "MapSid", + "name": "Sid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn Extension resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" }, "examples": { - "create": { + "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -11193,116 +6105,40 @@ "accountSid_authToken": [] } ], - "operationId": "CreateSyncSyncMapItem", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateSyncSyncMapItemRequest", - "properties": { - "Key": { - "type": "string", - "description": "" - }, - "Data": { - "description": "" - } - }, - "required": [ - "Key", - "Data" - ] - }, - "examples": { - "create": { - "value": { - "Data": "{}", - "Key": "key" - } - } - } - } - } + "operationId": "FetchMarketplaceAvailableAddOnExtension" + } + }, + "/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": { + "servers": [ + { + "url": "https://preview.twilio.com" } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/AvailableAddOns/{Sid}", + "className": "available_add_on_extension", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of Extensions for the Available Add-on.", "tags": [ - "PreviewSyncSyncMapItem" + "PreviewMarketplaceAvailableAddOnExtension" ], "parameters": [ { - "name": "ServiceSid", + "name": "AvailableAddOnSid", "in": "path", - "description": "", + "description": "The SID of the AvailableAddOn resource with the extensions to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "", - "schema": { - "type": "string" + "pattern": "^XB[0-9a-fA-F]{32}$" }, "required": true }, - { - "name": "Order", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" - }, - "examples": { - "readEmpty": { - "value": "asc" - }, - "readFull": { - "value": "asc" - } - } - }, - { - "name": "From", - "in": "query", - "description": "", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "from" - }, - "readFull": { - "value": "from" - } - } - }, - { - "name": "Bounds", - "in": "query", - "description": "", - "schema": { - "type": "string", - "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" - }, - "examples": { - "readEmpty": { - "value": "inclusive" - }, - "readFull": { - "value": "inclusive" - } - } - }, { "name": "PageSize", "in": "query", @@ -11337,12 +6173,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapItemResponse", + "title": "ListMarketplaceAvailableAddOnExtensionResponse", "properties": { - "items": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" + "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" } }, "meta": { @@ -11380,44 +6216,40 @@ } }, "examples": { - "readEmpty": { + "readFull": { "value": { - "items": [], + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "available_add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } }, - "readFull": { + "readEmpty": { "value": { - "items": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "created_by": "created_by", - "data": {}, - "date_created": "2015-07-30T20:00:00Z", - "date_updated": "2015-07-30T20:00:00Z", - "key": "key", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "revision": "revision", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" - } - ], + "extensions": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", - "key": "items", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -11432,10 +6264,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapItem" + "operationId": "ListMarketplaceAvailableAddOnExtension" } }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { + "/marketplace/InstalledAddOns": { "servers": [ { "url": "https://preview.twilio.com" @@ -11444,190 +6276,58 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions", - "pathType": "instance" - }, - "get": { - "description": "Fetch 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": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchSyncSyncMapPermission" - }, - "delete": { - "description": "Delete a specific Sync Map Permission.", - "tags": [ - "PreviewSyncSyncMapPermission" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "", - "schema": { - "type": "string", - "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" + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" }, - "required": true + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" + "usage": { + "mapping": { + "installed_add_on_sid": "sid" }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteSyncSyncMapPermission" + "pathType": "list" }, "post": { - "description": "Update an identity's access to a specific Sync Map.", + "description": "Install an Add-on for the Account specified.", "tags": [ - "PreviewSyncSyncMapPermission" - ], - "parameters": [ - { - "name": "ServiceSid", - "in": "path", - "description": "The unique SID identifier of the Sync Service Instance.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "MapSid", - "in": "path", - "description": "Identifier of the Sync Map. Either a SID or a unique name.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Identity", - "in": "path", - "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", - "schema": { - "type": "string" - }, - "required": true - } + "PreviewMarketplaceInstalledAddOn" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" }, "examples": { - "update": { + "create": { "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_1", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -11635,87 +6335,58 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateSyncSyncMapPermission", + "operationId": "CreateMarketplaceInstalledAddOn", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateSyncSyncMapPermissionRequest", + "title": "CreateMarketplaceInstalledAddOnRequest", "properties": { - "Read": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can read the Sync Map." + "AvailableAddOnSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "description": "The SID of the AvaliableAddOn to install." }, - "Write": { + "AcceptTermsOfService": { "type": "boolean", - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." + "description": "Whether the Terms of Service were accepted." }, - "Manage": { - "type": "boolean", - "description": "Boolean flag specifying whether the identity can delete the Sync Map." + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed." + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." } }, "required": [ - "Read", - "Write", - "Manage" + "AvailableAddOnSid", + "AcceptTermsOfService" ] }, "examples": { - "update": { + "create": { "value": { - "Read": "true", - "Write": "true", - "Manage": "true" + "AvailableAddOnSid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "AcceptTermsOfService": true, + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_1" } - } - } - } - } - } - } - }, - "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Services/{ServiceSid}/Maps/{Sid}", - "mountName": "sync_map_permissions", - "pathType": "list" + } + } + } + } + } }, "get": { - "description": "Retrieve a list of all Permissions applying to a Sync Map.", + "description": "Retrieve a list of Add-ons currently installed on this Account.", "tags": [ - "PreviewSyncSyncMapPermission" + "PreviewMarketplaceInstalledAddOn" ], "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", @@ -11750,12 +6421,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListSyncSyncMapPermissionResponse", + "title": "ListMarketplaceInstalledAddOnResponse", "properties": { - "permissions": { + "installed_add_ons": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } }, "meta": { @@ -11793,42 +6464,224 @@ } }, "examples": { - "readEmpty": { + "readFull": { "value": { - "permissions": [], + "installed_add_ons": [ + { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" } } }, - "readFull": { + "readEmpty": { "value": { - "permissions": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "identity": "identity", - "read": true, - "write": true, - "manage": true, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" - } - ], + "installed_add_ons": [], "meta": { - "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", - "key": "permissions", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0", + "next_page_url": null, + "key": "installed_add_ons" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListMarketplaceInstalledAddOn" + } + }, + "/marketplace/InstalledAddOns/{Sid}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "extensions": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions" + }, + "usage": { + "mapping": { + "installed_add_on_sid": "sid" + }, + "resource_url": "/marketplace/InstalledAddOns/{installed_add_on_sid}/Usage" + } + }, + "pathType": "instance" + }, + "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" + }, + "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" + }, + "examples": { + "fetch": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchMarketplaceInstalledAddOn" + }, + "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" + }, + "examples": { + "update": { + "value": { + "sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "VoiceBase High Accuracy Transcription", + "description": "Automatic Transcription and Keyword Extract...", + "configuration": { + "bad_words": true + }, + "unique_name": "voicebase_high_accuracy_transcription_2", + "date_created": "2016-04-07T23:52:28Z", + "date_updated": "2016-04-07T23:52:28Z", + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "extensions": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions", + "available_add_on": "https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -11843,10 +6696,37 @@ "accountSid_authToken": [] } ], - "operationId": "ListSyncSyncMapPermission" + "operationId": "UpdateMarketplaceInstalledAddOn", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateMarketplaceInstalledAddOnRequest", + "properties": { + "Configuration": { + "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured" + }, + "UniqueName": { + "type": "string", + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account." + } + } + }, + "examples": { + "update": { + "value": { + "Configuration": "{\"bad_words\": true}", + "UniqueName": "voicebase_high_accuracy_transcription_2" + } + } + } + } + } + } } }, - "/understand/Assistants/{Sid}": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -11855,70 +6735,37 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "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" - } - }, + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch an instance of an Extension for the Installed Add-on.", "tags": [ - "PreviewUnderstandAssistant" + "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": "A 34 character string that uniquely identifies this resource.", + "description": "The SID of the InstalledAddOn Extension resource to fetch.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } @@ -11928,32 +6775,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" }, "examples": { "fetch": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", - "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -11967,20 +6800,35 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistant" + "operationId": "FetchMarketplaceInstalledAddOnExtension" }, "post": { - "description": "", + "description": "Update an Extension for an Add-on installation.", "tags": [ - "PreviewUnderstandAssistant" + "PreviewMarketplaceInstalledAddOnExtension" ], "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": "A 34 character string that uniquely identifies this resource.", + "description": "The SID of the InstalledAddOn Extension resource to update.", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$" }, "required": true } @@ -11990,32 +6838,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" }, "examples": { "update": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", - "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": false, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -12029,94 +6863,36 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistant", + "operationId": "UpdateMarketplaceInstalledAddOnExtension", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantRequest", + "title": "UpdateMarketplaceInstalledAddOnExtensionRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." - }, - "LogQueries": { + "Enabled": { "type": "boolean", - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "A user-provided URL to send event callbacks to." - }, - "CallbackEvents": { - "type": "string", - "description": "Space-separated list of callback events that will trigger callbacks." - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant" + "description": "Whether the Extension should be invoked." } - } + }, + "required": [ + "Enabled" + ] }, "examples": { "update": { "value": { - "FriendlyName": "so so friendly", - "UniqueName": "so-so-unique", - "LogQueries": true, - "CallbackUrl": "https://example.com/callback_url", - "CallbackEvents": "model_build_completed model_build_failed", - "FallbackActions": "{\"actions\":[{}]}", - "InitiationActions": "{\"actions\":[{}]}", - "StyleSheet": "{}" + "Enabled": false } } } } } } - }, - "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" } }, - "/understand/Assistants": { + "/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": { "servers": [ { "url": "https://preview.twilio.com" @@ -12125,64 +6901,28 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "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" - } - }, + "parent": "/InstalledAddOns/{Sid}", + "className": "installed_add_on_extension", "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of Extensions for the Installed Add-on.", "tags": [ - "PreviewUnderstandAssistant" + "PreviewMarketplaceInstalledAddOnExtension" ], "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", @@ -12217,12 +6957,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandAssistantResponse", + "title": "ListMarketplaceInstalledAddOnExtensionResponse", "properties": { - "assistants": { + "extensions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant" + "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } }, "meta": { @@ -12260,55 +7000,41 @@ } }, "examples": { - "readEmpty": { + "readFull": { "value": { - "assistants": [], + "extensions": [ + { + "sid": "XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "installed_add_on_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "friendly_name": "Incoming Voice Call", + "product_name": "Programmable Voice", + "unique_name": "voice-incoming", + "enabled": true, + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0", - "key": "assistants", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } - } - }, - "readFull": { - "value": { - "assistants": [ - { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", - "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - ], + } + }, + "readEmpty": { + "value": { + "extensions": [], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0", - "key": "assistants", - "next_page_url": null, "page": 0, "page_size": 50, + "first_page_url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", "previous_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0" + "url": "https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0", + "next_page_url": null, + "key": "extensions" } } } @@ -12323,117 +7049,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandAssistant" - }, - "post": { - "description": "", - "tags": [ - "PreviewUnderstandAssistant" - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant" - }, - "examples": { - "create": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2017-07-04T08:34:00Z", - "date_updated": "2017-07-04T08:34:00Z", - "friendly_name": "so so friendly", - "latest_model_build_sid": null, - "log_queries": true, - "sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "so-so-unique", - "links": { - "field_types": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes", - "tasks": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks", - "model_builds": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds", - "queries": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries", - "assistant_fallback_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "assistant_initiation_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", - "dialogues": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues", - "style_sheet": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "callback_url": "https://example.com/callback_url", - "callback_events": "model_build_completed model_build_failed" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandAssistant", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandAssistantRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long." - }, - "LogQueries": { - "type": "boolean", - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "CallbackUrl": { - "type": "string", - "format": "uri", - "description": "A user-provided URL to send event callbacks to." - }, - "CallbackEvents": { - "type": "string", - "description": "Space-separated list of callback events that will trigger callbacks." - }, - "FallbackActions": { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task." - }, - "InitiationActions": { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first." - }, - "StyleSheet": { - "description": "The JSON object that holds the style sheet for the assistant" - } - } - }, - "examples": { - "create": { - "value": { - "FriendlyName": "so so friendly", - "UniqueName": "so-so-unique", - "LogQueries": true, - "CallbackUrl": "https://example.com/callback_url", - "CallbackEvents": "model_build_completed model_build_failed", - "FallbackActions": "{\"actions\":[{}]}", - "InitiationActions": "{\"actions\":[{}]}", - "StyleSheet": "{}" - } - } - } - } - } - } + "operationId": "ListMarketplaceInstalledAddOnExtension" } }, - "/understand/Assistants/{AssistantSid}/FallbackActions": { + "/Sync/Services/{ServiceSid}/Documents/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -12442,19 +7061,38 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "mountName": "assistant_fallback_actions", - "className": "assistant_fallback_actions", + "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" }, "get": { "description": "", "tags": [ - "PreviewUnderstandAssistantFallbackActions" + "PreviewSyncDocument" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", "in": "path", "description": "", "schema": { @@ -12468,15 +7106,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "data": {} + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } } } @@ -12490,22 +7137,82 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandAssistantFallbackActions" + "operationId": "FetchSyncDocument" + }, + "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" }, "post": { "description": "", "tags": [ - "PreviewUnderstandAssistantFallbackActions" + "PreviewSyncDocument" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -12513,15 +7220,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" + "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions", - "data": {} + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } } } @@ -12535,23 +7251,27 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistantFallbackActions", + "operationId": "UpdateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantFallbackActionsRequest", + "title": "UpdateSyncDocumentRequest", "properties": { - "FallbackActions": { + "Data": { "description": "" } - } + }, + "required": [ + "Data" + ] }, "examples": { "update": { "value": { - "FallbackActions": "{\"actions\":[{}]}" + "Data": "{}", + "UniqueName": "unique_name" } } } @@ -12560,7 +7280,7 @@ } } }, - "/understand/Assistants/{AssistantSid}/InitiationActions": { + "/Sync/Services/{ServiceSid}/Documents": { "servers": [ { "url": "https://preview.twilio.com" @@ -12569,92 +7289,66 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "mountName": "assistant_initiation_actions", - "className": "assistant_initiation_actions", - "pathType": "instance" - }, - "get": { - "description": "", - "tags": [ - "PreviewUnderstandAssistantInitiationActions" - ], - "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "data": {}, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions" - } - } - } - } + "dependentProperties": { + "document_permissions": { + "mapping": { + "service_sid": "service_sid", + "document_sid": "sid" }, - "description": "OK" + "resource_url": "/Sync/Services/{service_sid}/Documents/{document_sid}/Permissions" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUnderstandAssistantInitiationActions" + "parent": "/Services/{Sid}", + "pathType": "list" }, "post": { "description": "", "tags": [ - "PreviewUnderstandAssistantInitiationActions" + "PreviewSyncDocument" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" + "$ref": "#/components/schemas/preview.sync.service.document" }, "examples": { - "update": { + "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions", - "data": {} + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -12662,66 +7356,79 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandAssistantInitiationActions", + "operationId": "CreateSyncDocument", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandAssistantInitiationActionsRequest", + "title": "CreateSyncDocumentRequest", "properties": { - "InitiationActions": { + "UniqueName": { + "type": "string", + "description": "" + }, + "Data": { "description": "" } } }, "examples": { - "update": { + "create": { "value": { - "InitiationActions": "{\"actions\":[{}]}" + "Data": "{}", + "UniqueName": "unique_name" } } } } } } - } - }, - "/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewUnderstandDialogue" + "PreviewSyncDocument" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "", + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" - }, - "required": true + } } ], "responses": { @@ -12729,16 +7436,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.dialogue" + "type": "object", + "title": "ListSyncDocumentResponse", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.sync.service.document" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } }, "examples": { - "fetch": { + "readEmpty": { "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk", - "data": {} + "documents": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "documents": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "links": { + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + } + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0", + "key": "documents", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0" + } } } } @@ -12752,23 +7535,10 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandDialogue" - } - }, - "/understand/Assistants/{AssistantSid}/Dialogues": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "list" + "operationId": "ListSyncDocument" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -12777,37 +7547,41 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", "pathType": "instance" }, "get": { - "description": "", + "description": "Fetch a specific Sync Document Permission.", "tags": [ - "PreviewUnderstandField" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "DocumentSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "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": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -12819,20 +7593,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" }, "examples": { "fetch": { "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -12846,36 +7619,88 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandField" + "operationId": "FetchSyncDocumentPermission" }, "delete": { - "description": "", + "description": "Delete a specific Sync Document Permission.", "tags": [ - "PreviewUnderstandField" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "DocumentSid", + "in": "path", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Identity", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncDocumentPermission" + }, + "post": { + "description": "Update an identity's access to a specific Sync Document.", + "tags": [ + "PreviewSyncDocumentPermission" + ], + "parameters": [ + { + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "TaskSid", + "name": "DocumentSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "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": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -12883,8 +7708,29 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" + }, + "examples": { + "update": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -12892,10 +7738,48 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandField" + "operationId": "UpdateSyncDocumentPermission", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateSyncDocumentPermissionRequest", + "properties": { + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Document." + }, + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can update the Sync Document." + }, + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Document." + } + }, + "required": [ + "Read", + "Write", + "Manage" + ] + }, + "examples": { + "update": { + "value": { + "Read": "true", + "Write": "true", + "Manage": "true" + } + } + } + } + } + } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": { + "/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -12904,28 +7788,32 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "parent": "/Services/{ServiceSid}/Documents/{Sid}", + "mountName": "document_permissions", "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Document.", "tags": [ - "PreviewUnderstandField" + "PreviewSyncDocumentPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "DocumentSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "description": "Identifier of the Sync Document. Either a SID or a unique name.", "schema": { "type": "string" }, @@ -12965,12 +7853,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldResponse", + "title": "ListSyncDocumentPermissionResponse", "properties": { - "fields": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.field" + "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } }, "meta": { @@ -13010,41 +7898,40 @@ "examples": { "readEmpty": { "value": { - "fields": [], + "permissions": [], "meta": { - "page": 0, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "key": "fields", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, + "page": 0, + "page_size": 50, "previous_page_url": null, - "page_size": 50 + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { - "fields": [ + "permissions": [ { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "document_sid": "ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { - "page": 0, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0", - "key": "fields", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, + "page": 0, + "page_size": 50, "previous_page_url": null, - "page_size": 50 + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -13059,101 +7946,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandField" - }, - "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" - }, - "examples": { - "create": { - "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type": "field_type" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandField", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandFieldRequest", - "properties": { - "FieldType": { - "type": "string", - "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type." - }, - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - } - }, - "required": [ - "FieldType", - "UniqueName" - ] - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "FieldType": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } + "operationId": "ListSyncDocumentPermission" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": { + "/Sync/Services/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -13163,38 +7959,42 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "field_values": { + "documents": { + "mapping": { + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Documents" + }, + "sync_lists": { "mapping": { - "assistant_sid": "assistant_sid", - "field_type_sid": "sid" + "service_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists" + }, + "sync_maps": { + "mapping": { + "service_sid": "sid" }, - "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + "resource_url": "/Sync/Services/{service_sid}/Maps" } }, - "parent": "/Assistants/{Sid}", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewUnderstandFieldType" + "PreviewSyncService" ], "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -13204,22 +8004,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.sync.service" }, "examples": { "fetch": { "value": { - "unique_name": "unique_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", "links": { - "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false } } } @@ -13233,29 +8036,54 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandFieldType" + "operationId": "FetchSyncService" }, - "post": { + "delete": { "description": "", "tags": [ - "PreviewUnderstandFieldType" + "PreviewSyncService" ], "parameters": [ { - "name": "AssistantSid", + "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncService" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncService" + ], + "parameters": [ { "name": "Sid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } @@ -13265,22 +8093,25 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.sync.service" }, "examples": { "update": { "value": { - "unique_name": "unique_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", "links": { - "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true } } } @@ -13294,75 +8125,48 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandFieldType", + "operationId": "UpdateSyncService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandFieldTypeRequest", + "title": "UpdateSyncServiceRequest", "properties": { - "FriendlyName": { + "WebhookUrl": { "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." + "format": "uri", + "description": "" }, - "UniqueName": { + "FriendlyName": { "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" } } }, "examples": { "update": { "value": { - "UniqueName": "unique_name", - "FriendlyName": "friendly_name" + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true } } } } } } - }, - "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" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes": { + "/Sync/Services": { "servers": [ { "url": "https://preview.twilio.com" @@ -13372,32 +8176,115 @@ "x-twilio": { "defaultOutputProperties": [], "dependentProperties": { - "field_values": { + "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": { - "assistant_sid": "assistant_sid", - "field_type_sid": "sid" + "service_sid": "sid" }, - "resource_url": "/understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues" + "resource_url": "/Sync/Services/{service_sid}/Maps" } }, - "parent": "/Assistants/{Sid}", "pathType": "list" }, + "post": { + "description": "", + "tags": [ + "PreviewSyncService" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", + "links": { + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" + }, + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": true + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSyncService", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncServiceRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "" + }, + "WebhookUrl": { + "type": "string", + "format": "uri", + "description": "" + }, + "ReachabilityWebhooksEnabled": { + "type": "boolean", + "description": "" + }, + "AclEnabled": { + "type": "boolean", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "FriendlyName": "friendly_name", + "WebhookUrl": "http://www.example.com", + "AclEnabled": true + } + } + } + } + } + } + }, "get": { "description": "", "tags": [ - "PreviewUnderstandFieldType" + "PreviewSyncService" ], "parameters": [ - { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, { "name": "PageSize", "in": "query", @@ -13432,12 +8319,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldTypeResponse", + "title": "ListSyncServiceResponse", "properties": { - "field_types": { + "services": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type" + "$ref": "#/components/schemas/preview.sync.service" } }, "meta": { @@ -13478,101 +8365,52 @@ "readEmpty": { "value": { "meta": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "previous_page_url": null, + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, "page": 0, "page_size": 50, - "next_page_url": null, - "key": "field_types" + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" }, - "field_types": [] + "services": [] } }, "readFull": { "value": { "meta": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0", - "previous_page_url": null, + "first_page_url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0", + "key": "services", + "next_page_url": null, "page": 0, "page_size": 50, - "next_page_url": null, - "key": "field_types" + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services?PageSize=50&Page=0" }, - "field_types": [ + "services": [ { - "unique_name": "unique_name", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_updated": "2015-07-30T20:00:00Z", + "friendly_name": "friendly_name", "links": { - "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" + "documents": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents", + "lists": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists", + "maps": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps" }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - ] - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "ListUnderstandFieldType" - }, - "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" - }, - "examples": { - "create": { - "value": { - "unique_name": "unique_name", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "links": { - "field_values": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues" - }, - "sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "webhook_url": "http://www.example.com", + "reachability_webhooks_enabled": false, + "acl_enabled": false + } + ] } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -13580,41 +8418,10 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandFieldType", - "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" - ] - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "FriendlyName": "friendly_name" - } - } - } - } - } - } + "operationId": "ListSyncService" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": { + "/Sync/Services/{ServiceSid}/Lists/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -13623,30 +8430,41 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewUnderstandFieldValue" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -13665,21 +8483,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.sync.service.sync_list" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": null + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -13693,29 +8514,23 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandFieldValue" + "operationId": "FetchSyncSyncList" }, "delete": { "description": "", "tags": [ - "PreviewUnderstandFieldValue" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "FieldTypeSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, @@ -13739,10 +8554,10 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandFieldValue" + "operationId": "DeleteSyncSyncList" } }, - "/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": { + "/Sync/Services/{ServiceSid}/Lists": { "servers": [ { "url": "https://preview.twilio.com" @@ -13751,49 +8566,124 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}", + "dependentProperties": { + "sync_list_items": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Items" + }, + "sync_list_permissions": { + "mapping": { + "service_sid": "service_sid", + "list_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Lists/{list_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_lists", "pathType": "list" }, - "get": { + "post": { "description": "", "tags": [ - "PreviewUnderstandFieldValue" + "PreviewSyncSyncList" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateSyncSyncList", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncListRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "" + } + } + }, + "examples": { + "create": { + "value": { + "UniqueName": "unique_name" + } + } + } + } + } + } + }, + "get": { + "description": "", + "tags": [ + "PreviewSyncSyncList" + ], + "parameters": [ { - "name": "FieldTypeSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, - { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the value. For example: *en-US*", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, { "name": "PageSize", "in": "query", @@ -13828,12 +8718,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandFieldValueResponse", + "title": "ListSyncSyncListResponse", "properties": { - "field_values": { + "lists": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.sync.service.sync_list" } }, "meta": { @@ -13873,42 +8763,45 @@ "examples": { "readEmpty": { "value": { - "field_values": [], + "lists": [], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, "page_size": 50, "previous_page_url": null, - "key": "field_values", - "page": 0, - "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } }, "readFull": { "value": { - "field_values": [ + "lists": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + "date_updated": "2015-07-30T20:00:00Z", + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0", + "key": "lists", + "next_page_url": null, + "page": 0, "page_size": 50, "previous_page_url": null, - "key": "field_values", - "page": 0, - "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0" + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0" } } } @@ -13923,59 +8816,85 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandFieldValue" + "operationId": "ListSyncSyncList" + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", + "pathType": "instance" }, - "post": { + "get": { "description": "", "tags": [ - "PreviewUnderstandFieldValue" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "FieldTypeSid", + "name": "ListSid", "in": "path", "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "Index", + "in": "path", + "description": "", + "schema": { + "type": "integer" + }, + "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { - "create": { + "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "field_type_sid": "UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "language": "language", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "value": "value", - "date_updated": "2015-07-30T20:00:00Z", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "sid": "UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "synonym_of": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -13983,109 +8902,56 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandFieldValue", - "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" - ] - }, - "examples": { - "create": { - "value": { - "Value": "value", - "Language": "language", - "SynonymOf": "UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" - } - } - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "instance" + "operationId": "FetchSyncSyncListItem" }, - "get": { + "delete": { "description": "", "tags": [ - "PreviewUnderstandModelBuild" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "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.understand.assistant.model_build" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "enqueued", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": null - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -14093,31 +8959,51 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandModelBuild" + "operationId": "DeleteSyncSyncListItem" }, "post": { "description": "", "tags": [ - "PreviewUnderstandModelBuild" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "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": { @@ -14125,21 +9011,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "completed", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": 100, - "error_code": null + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } } } @@ -14153,48 +9039,67 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandModelBuild", + "operationId": "UpdateSyncSyncListItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandModelBuildRequest", + "title": "UpdateSyncSyncListItemRequest", "properties": { - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1" + "Data": { + "description": "" } - } + }, + "required": [ + "Data" + ] }, "examples": { "update": { "value": { - "UniqueName": "unique_name" + "Data": "{}" } } } } } } + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_items", + "pathType": "list" }, - "delete": { + "post": { "description": "", "tags": [ - "PreviewUnderstandModelBuild" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -14204,8 +9109,31 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" + }, + "examples": { + "create": { + "value": { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" + } + } + } + } + }, + "description": "Created" } }, "security": [ @@ -14213,29 +9141,53 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteUnderstandModelBuild" - } - }, - "/understand/Assistants/{AssistantSid}/ModelBuilds": { - "servers": [ - { - "url": "https://preview.twilio.com" + "operationId": "CreateSyncSyncListItem", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateSyncSyncListItemRequest", + "properties": { + "Data": { + "description": "" + } + }, + "required": [ + "Data" + ] + }, + "examples": { + "create": { + "value": { + "Data": "{}" + } + } + } + } + } } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "list" }, "get": { "description": "", "tags": [ - "PreviewUnderstandModelBuild" + "PreviewSyncSyncListItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", "in": "path", "description": "", "schema": { @@ -14243,6 +9195,56 @@ }, "required": true }, + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_list_item_enum_query_result_order" + }, + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } + } + }, + { + "name": "From", + "in": "query", + "description": "", + "schema": { + "type": "string" + }, + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } + } + }, + { + "name": "Bounds", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type" + }, + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } + } + }, { "name": "PageSize", "in": "query", @@ -14277,12 +9279,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandModelBuildResponse", + "title": "ListSyncSyncListItemResponse", "properties": { - "model_builds": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } }, "meta": { @@ -14322,43 +9324,43 @@ "examples": { "readEmpty": { "value": { + "items": [], "meta": { - "page": 0, - "key": "model_builds", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", "next_page_url": null, + "page": 0, + "page_size": 50, "previous_page_url": null, - "page_size": 50 - }, - "model_builds": [] + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } } }, "readFull": { "value": { - "meta": { - "page": 0, - "key": "model_builds", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0", - "next_page_url": null, - "previous_page_url": null, - "page_size": 50 - }, - "model_builds": [ + "items": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "failed", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": 23001 + "date_updated": "2015-07-30T20:00:00Z", + "index": 100, + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100" } - ] + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } } } } @@ -14372,18 +9374,53 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandModelBuild" + "operationId": "ListSyncSyncListItem" + } + }, + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", + "pathType": "instance" }, - "post": { - "description": "", + "get": { + "description": "Fetch a specific Sync List Permission.", "tags": [ - "PreviewUnderstandModelBuild" + "PreviewSyncSyncListPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", + "in": "path", + "description": "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" }, @@ -14391,31 +9428,29 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.model_build" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" }, "examples": { - "create": { + "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "status": "enqueued", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "unique_name": "unique_name", - "build_duration": null, - "error_code": null + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -14423,69 +9458,39 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandModelBuild", - "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" - } - } - }, - "examples": { - "create": { - "value": { - "UniqueName": "unique_name", - "StatusCallback": "http://www.example.com" - } - } - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/Queries/{Sid}": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "instance" + "operationId": "FetchSyncSyncListPermission" }, - "get": { - "description": "", + "delete": { + "description": "Delete a specific Sync List Permission.", "tags": [ - "PreviewUnderstandQuery" + "PreviewSyncSyncListPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -14493,47 +9498,8 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" - }, - "examples": { - "fetch": { - "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": { - "name": "name", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": 0.9 - }, - "entities": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "voice" - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -14541,27 +9507,39 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandQuery" + "operationId": "DeleteSyncSyncListPermission" }, "post": { - "description": "", + "description": "Update an identity's access to a specific Sync List.", "tags": [ - "PreviewUnderstandQuery" + "PreviewSyncSyncListPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ListSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "Sid", + "name": "Identity", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -14573,37 +9551,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" }, "examples": { "update": { "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": { - "name": "name", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": 0.9 - }, - "entities": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "sms" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -14617,78 +9577,48 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandQuery", + "operationId": "UpdateSyncSyncListPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandQueryRequest", + "title": "UpdateSyncSyncListPermissionRequest", "properties": { - "SampleSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "description": "An optional reference to the Sample created from this query." + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync List." }, - "Status": { - "type": "string", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded" + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List." + }, + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync List." } - } + }, + "required": [ + "Read", + "Write", + "Manage" + ] }, "examples": { "update": { "value": { - "Status": "status", - "SampleSid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "Read": "true", + "Write": "true", + "Manage": "true" } } } } } } - }, - "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" } }, - "/understand/Assistants/{AssistantSid}/Queries": { + "/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -14697,71 +9627,36 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", + "parent": "/Services/{ServiceSid}/Lists/{Sid}", + "mountName": "sync_list_permissions", "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync List.", "tags": [ - "PreviewUnderstandQuery" + "PreviewSyncSyncListPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Language", - "in": "query", - "description": "An ISO language-country string of the sample.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, - { - "name": "ModelBuild", - "in": "query", - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "schema": { - "type": "string" - }, - "examples": { - "readEmpty": { - "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - }, - "readFull": { - "value": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - }, - { - "name": "Status", - "in": "query", - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "name": "ListSid", + "in": "path", + "description": "Identifier of the Sync List. Either a SID or a unique name.", "schema": { "type": "string" }, - "examples": { - "readEmpty": { - "value": "status" - }, - "readFull": { - "value": "status" - } - } + "required": true }, { "name": "PageSize", @@ -14797,12 +9692,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandQueryResponse", + "title": "ListSyncSyncListPermissionResponse", "properties": { - "queries": { + "permissions": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.query" + "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } }, "meta": { @@ -14842,58 +9737,40 @@ "examples": { "readEmpty": { "value": { - "queries": [], + "permissions": [], "meta": { - "previous_page_url": null, + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", "page": 0, - "key": "queries", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page_size": 50 + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } }, "readFull": { "value": { - "queries": [ + "permissions": [ { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": { - "name": "name", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": 0.9 - }, - "entities": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": null + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } ], "meta": { - "previous_page_url": null, + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", "next_page_url": null, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", "page": 0, - "key": "queries", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0", - "page_size": 50 + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0" } } } @@ -14908,124 +9785,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandQuery" - }, - "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" - }, - "examples": { - "create": { - "value": { - "language": "language", - "date_created": "2015-07-30T20:00:00Z", - "model_build_sid": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "query": "query", - "date_updated": "2015-07-30T20:00:00Z", - "status": "status", - "sample_sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "results": { - "task": { - "name": "name", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "confidence": 0.9 - }, - "entities": [ - { - "name": "name", - "value": "value", - "type": "type" - } - ] - }, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "source_channel": "voice" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandQuery", - "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" - ] - }, - "examples": { - "create": { - "value": { - "Language": "language", - "Query": "query", - "Tasks": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", - "Field": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "ModelBuild": "UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" - } - } - } - } - } - } + "operationId": "ListSyncSyncListPermission" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{Sid}": { "servers": [ { "url": "https://preview.twilio.com" @@ -15034,42 +9797,50 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" + }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps", "pathType": "instance" }, "get": { "description": "", "tags": [ - "PreviewUnderstandSample" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "type": "string" }, "required": true } @@ -15079,21 +9850,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.sync.service.sync_map" }, "examples": { "fetch": { "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", "date_updated": "2015-07-30T20:00:00Z", - "source_channel": null + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } @@ -15107,71 +9881,126 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandSample" + "operationId": "FetchSyncSyncMap" }, - "post": { + "delete": { "description": "", "tags": [ - "PreviewUnderstandSample" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "Sid", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteSyncSyncMap" + } + }, + "/Sync/Services/{ServiceSid}/Maps": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "dependentProperties": { + "sync_map_items": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Items" }, + "sync_map_permissions": { + "mapping": { + "service_sid": "service_sid", + "map_sid": "sid" + }, + "resource_url": "/Sync/Services/{service_sid}/Maps/{map_sid}/Permissions" + } + }, + "parent": "/Services/{Sid}", + "mountName": "sync_maps", + "pathType": "list" + }, + "post": { + "description": "", + "tags": [ + "PreviewSyncSyncMap" + ], + "parameters": [ { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.sync.service.sync_map" }, "examples": { - "update": { + "create": { "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "alexa" + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -15179,33 +10008,24 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandSample", + "operationId": "CreateSyncSyncMap", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandSampleRequest", + "title": "CreateSyncSyncMapRequest", "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "SourceChannel": { + "UniqueName": { "type": "string", - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" + "description": "" } } }, "examples": { - "update": { + "create": { "value": { - "Language": "language", - "TaggedText": "tagged_text" + "UniqueName": "unique_name" } } } @@ -15213,108 +10033,24 @@ } } }, - "delete": { + "get": { "description": "", "tags": [ - "PreviewUnderstandSample" + "PreviewSyncSyncMap" ], "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "TaskSid", - "in": "path", - "description": "The unique ID of the Task associated with this Sample.", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "Sid", + "name": "ServiceSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteUnderstandSample" - } - }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "pathType": "list" - }, - "get": { - "description": "", - "tags": [ - "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" + "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" - }, - "examples": { - "readEmpty": { - "value": "language" - }, - "readFull": { - "value": "language" - } - } - }, { "name": "PageSize", "in": "query", @@ -15349,12 +10085,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandSampleResponse", + "title": "ListSyncSyncMapResponse", "properties": { - "samples": { + "maps": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.sync.service.sync_map" } }, "meta": { @@ -15394,42 +10130,45 @@ "examples": { "readEmpty": { "value": { - "samples": [], + "maps": [], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "previous_page_url": null, - "key": "samples", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", "page": 0, - "page_size": 50 + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } }, "readFull": { "value": { - "samples": [ + "maps": [ { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "sms" + "links": { + "items": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items", + "permissions": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions" + }, + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "unique_name": "unique_name", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", - "previous_page_url": null, - "key": "samples", + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0", + "key": "maps", "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0", "page": 0, - "page_size": 50 + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0" } } } @@ -15444,27 +10183,53 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandSample" + "operationId": "ListSyncSyncMap" + } + }, + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": { + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [], + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items", + "pathType": "instance" }, - "post": { + "get": { "description": "", "tags": [ - "PreviewUnderstandSample" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { "type": "string" }, "required": true }, { - "name": "TaskSid", + "name": "Key", "in": "path", - "description": "The unique ID of the Task associated with this Sample.", + "description": "", "schema": { "type": "string" }, @@ -15472,31 +10237,31 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.sample" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { - "create": { + "fetch": { "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "language": "language", - "tagged_text": "tagged_text", "date_updated": "2015-07-30T20:00:00Z", - "source_channel": "alexa" + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -15504,94 +10269,56 @@ "accountSid_authToken": [] } ], - "operationId": "CreateUnderstandSample", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandSampleRequest", - "properties": { - "Language": { - "type": "string", - "description": "An ISO language-country string of the sample." - }, - "TaggedText": { - "type": "string", - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks." - }, - "SourceChannel": { - "type": "string", - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null" - } - }, - "required": [ - "Language", - "TaggedText" - ] - }, - "examples": { - "create": { - "value": { - "Language": "language", - "TaggedText": "tagged_text", - "SourceChannel": "alexa" - } - } - } - } - } - } - } - }, - "/understand/Assistants/{AssistantSid}/StyleSheet": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "parent": "/Assistants/{Sid}", - "pathType": "instance" + "operationId": "FetchSyncSyncMapItem" }, - "get": { - "description": "Returns Style sheet JSON object for this Assistant", + "delete": { + "description": "", "tags": [ - "PreviewUnderstandStyleSheet" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", "in": "path", - "description": "The unique ID of the Assistant", + "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.understand.assistant.style_sheet" - }, - "examples": { - "fetch": { - "value": { - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "data": {}, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet" - } - } - } - } - }, - "description": "OK" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -15599,22 +10326,51 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandStyleSheet" + "operationId": "DeleteSyncSyncMapItem" }, "post": { - "description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.", + "description": "", "tags": [ - "PreviewUnderstandStyleSheet" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", + "in": "path", + "description": "", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Key", "in": "path", - "description": "The unique ID of the Assistant", + "description": "", "schema": { "type": "string" }, "required": true + }, + { + "name": "If-Match", + "in": "header", + "description": "The If-Match HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -15622,15 +10378,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet", - "data": {} + "created_by": "created_by", + "data": {}, + "date_created": "2015-07-30T20:00:00Z", + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } @@ -15644,23 +10406,26 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandStyleSheet", + "operationId": "UpdateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandStyleSheetRequest", + "title": "UpdateSyncSyncMapItemRequest", "properties": { - "StyleSheet": { - "description": "The JSON Style sheet string" + "Data": { + "description": "" } - } + }, + "required": [ + "Data" + ] }, "examples": { "update": { "value": { - "StyleSheet": "{}" + "Data": "{}" } } } @@ -15669,7 +10434,7 @@ } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{Sid}": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": { "servers": [ { "url": "https://preview.twilio.com" @@ -15678,123 +10443,32 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "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}", - "pathType": "instance" - }, - "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" - }, - "examples": { - "fetch": { - "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - } - } - } - }, - "description": "OK" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "FetchUnderstandTask" + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_items", + "pathType": "list" }, "post": { "description": "", "tags": [ - "PreviewUnderstandTask" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "name": "MapSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, @@ -15802,36 +10476,31 @@ } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" }, "examples": { - "update": { + "create": { "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } } } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -15839,39 +10508,32 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTask", + "operationId": "CreateSyncSyncMapItem", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandTaskRequest", + "title": "CreateSyncSyncMapItemRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "UniqueName": { + "Key": { "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." + "description": "" }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" + "Data": { + "description": "" } - } + }, + "required": [ + "Key", + "Data" + ] }, "examples": { - "update": { + "create": { "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Actions": "{\"say\":{\"speech\":\"Your order is ready for pickup\"}}", - "ActionsUrl": "https://example.com/actions_url" + "Data": "{}", + "Key": "key" } } } @@ -15879,100 +10541,82 @@ } } }, - "delete": { + "get": { "description": "", "tags": [ - "PreviewUnderstandTask" + "PreviewSyncSyncMapItem" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", + "name": "MapSid", "in": "path", - "description": "A 34 character string that uniquely identifies this resource.", + "description": "", "schema": { "type": "string" }, "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteUnderstandTask" - } - }, - "/understand/Assistants/{AssistantSid}/Tasks": { - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "description": "", - "x-twilio": { - "defaultOutputProperties": [], - "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" + { + "name": "Order", + "in": "query", + "description": "", + "schema": { + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_result_order" }, - "resource_url": "/understand/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples" + "examples": { + "readEmpty": { + "value": "asc" + }, + "readFull": { + "value": "asc" + } + } }, - "task_actions": { - "mapping": { - "assistant_sid": "assistant_sid", - "task_sid": "sid" + { + "name": "From", + "in": "query", + "description": "", + "schema": { + "type": "string" }, - "resource_url": "/understandNone" + "examples": { + "readEmpty": { + "value": "from" + }, + "readFull": { + "value": "from" + } + } }, - "statistics": { - "mapping": { - "assistant_sid": "assistant_sid", - "task_sid": "sid" - }, - "resource_url": "/understandNone" - } - }, - "parent": "/Assistants/{Sid}", - "pathType": "list" - }, - "get": { - "description": "", - "tags": [ - "PreviewUnderstandTask" - ], - "parameters": [ { - "name": "AssistantSid", - "in": "path", - "description": "The unique ID of the Assistant.", + "name": "Bounds", + "in": "query", + "description": "", "schema": { - "type": "string" + "type": "string", + "$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type" }, - "required": true + "examples": { + "readEmpty": { + "value": "inclusive" + }, + "readFull": { + "value": "inclusive" + } + } }, { "name": "PageSize", @@ -16008,12 +10652,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListUnderstandTaskResponse", + "title": "ListSyncSyncMapItemResponse", "properties": { - "tasks": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/preview.understand.assistant.task" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } }, "meta": { @@ -16053,48 +10697,43 @@ "examples": { "readEmpty": { "value": { + "items": [], "meta": { - "key": "tasks", - "page_size": 50, + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", "page": 0, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "previous_page_url": null - }, - "tasks": [] + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } } }, "readFull": { "value": { - "meta": { - "key": "tasks", - "page_size": 50, - "next_page_url": null, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "page": 0, - "first_page_url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0", - "previous_page_url": null - }, - "tasks": [ + "items": [ { - "unique_name": "unique_name", - "links": { - "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "created_by": "created_by", + "data": {}, "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" + "date_updated": "2015-07-30T20:00:00Z", + "key": "key", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "revision": "revision", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key" } - ] + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0", + "key": "items", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0" + } } } } @@ -16108,107 +10747,10 @@ "accountSid_authToken": [] } ], - "operationId": "ListUnderstandTask" - }, - "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" - }, - "examples": { - "create": { - "value": { - "unique_name": "unique_name", - "links": { - "fields": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields", - "samples": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples", - "task_actions": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions", - "statistics": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics" - }, - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "friendly_name": "friendly_name", - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_updated": "2015-07-30T20:00:00Z", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "date_created": "2015-07-30T20:00:00Z", - "actions_url": "https://example.com/actions_url" - } - } - } - } - }, - "description": "Created" - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "CreateUnderstandTask", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateUnderstandTaskRequest", - "properties": { - "UniqueName": { - "type": "string", - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long." - }, - "FriendlyName": { - "type": "string", - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long." - }, - "Actions": { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique." - }, - "ActionsUrl": { - "type": "string", - "format": "uri", - "description": "User-provided HTTP endpoint where from the assistant fetches actions" - } - }, - "required": [ - "UniqueName" - ] - }, - "examples": { - "create": { - "value": { - "FriendlyName": "friendly_name", - "UniqueName": "unique_name", - "Actions": "{\"say\":{\"speech\":\"Your order is ready for pickup\"}}", - "ActionsUrl": "https://example.com/actions_url" - } - } - } - } - } - } + "operationId": "ListSyncSyncMapItem" } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": { "servers": [ { "url": "https://preview.twilio.com" @@ -16217,30 +10759,41 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "mountName": "task_actions", - "className": "task_actions", + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", "pathType": "instance" }, "get": { - "description": "Returns JSON actions for this Task.", + "description": "Fetch a specific Sync Map Permission.", "tags": [ - "PreviewUnderstandTaskActions" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "TaskSid", + "name": "Identity", "in": "path", - "description": "The unique ID of the Task.", + "description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -16252,16 +10805,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDdddddddddddddddddddddddddddddddd", - "data": {}, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -16275,27 +10831,88 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandTaskActions" + "operationId": "FetchSyncSyncMapPermission" + }, + "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" }, "post": { - "description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.", + "description": "Update an identity's access to a specific Sync Map.", "tags": [ - "PreviewUnderstandTaskActions" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", + "in": "path", + "description": "The unique SID identifier of the Sync Service Instance.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "MapSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "Identifier of the Sync Map. Either a SID or a unique name.", "schema": { "type": "string" }, "required": true }, { - "name": "TaskSid", + "name": "Identity", "in": "path", - "description": "The unique ID of the Task.", + "description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.", "schema": { "type": "string" }, @@ -16307,16 +10924,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDdddddddddddddddddddddddddddddddd", - "data": {}, - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions" + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" } } } @@ -16330,23 +10950,39 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateUnderstandTaskActions", + "operationId": "UpdateSyncSyncMapPermission", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateUnderstandTaskActionsRequest", + "title": "UpdateSyncSyncMapPermissionRequest", "properties": { - "Actions": { - "description": "The JSON actions that instruct the Assistant how to perform this task." + "Read": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can read the Sync Map." + }, + "Write": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map." + }, + "Manage": { + "type": "boolean", + "description": "Boolean flag specifying whether the identity can delete the Sync Map." } - } + }, + "required": [ + "Read", + "Write", + "Manage" + ] }, "examples": { "update": { "value": { - "Actions": "{\"actions\":[{}]}" + "Read": "true", + "Write": "true", + "Manage": "true" } } } @@ -16355,7 +10991,7 @@ } } }, - "/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": { + "/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": { "servers": [ { "url": "https://preview.twilio.com" @@ -16364,33 +11000,63 @@ "description": "", "x-twilio": { "defaultOutputProperties": [], - "parent": "/Assistants/{AssistantSid}/Tasks/{Sid}", - "className": "task_statistics", - "pathType": "instance" + "parent": "/Services/{ServiceSid}/Maps/{Sid}", + "mountName": "sync_map_permissions", + "pathType": "list" }, "get": { - "description": "", + "description": "Retrieve a list of all Permissions applying to a Sync Map.", "tags": [ - "PreviewUnderstandTaskStatistics" + "PreviewSyncSyncMapPermission" ], "parameters": [ { - "name": "AssistantSid", + "name": "ServiceSid", "in": "path", - "description": "The unique ID of the parent Assistant.", + "description": "", "schema": { - "type": "string" + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "TaskSid", + "name": "MapSid", "in": "path", - "description": "The unique ID of the Task associated with this Field.", + "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": { @@ -16398,17 +11064,87 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" + "type": "object", + "title": "ListSyncSyncMapPermissionResponse", + "properties": { + "permissions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" + } + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "nullable": true, + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } }, "examples": { - "fetch": { + "readEmpty": { "value": { - "url": "https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", - "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "assistant_sid": "UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "task_sid": "UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", - "samples_count": 0, - "fields_count": 0 + "permissions": [], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } + } + }, + "readFull": { + "value": { + "permissions": [ + { + "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "identity": "identity", + "read": true, + "write": true, + "manage": true, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity" + } + ], + "meta": { + "first_page_url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0", + "key": "permissions", + "next_page_url": null, + "page": 0, + "page_size": 50, + "previous_page_url": null, + "url": "https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0" + } } } } @@ -16422,7 +11158,7 @@ "accountSid_authToken": [] } ], - "operationId": "FetchUnderstandTaskStatistics" + "operationId": "ListSyncSyncMapPermission" } }, "/wireless/Commands/{Sid}": { @@ -17284,7 +12020,7 @@ "mapping": { "sim_sid": "sid" }, - "resource_url": "/wirelessNone" + "resource_url": "/wireless/Sims/{sim_sid}/Usage" } }, "pathType": "instance" @@ -17585,7 +12321,7 @@ "mapping": { "sim_sid": "sid" }, - "resource_url": "/wirelessNone" + "resource_url": "/wireless/Sims/{sim_sid}/Usage" } }, "pathType": "list" @@ -17918,5 +12654,10 @@ { "name": "PreviewDeployedDevicesKey" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index fd8a136e..2841e9e5 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -1251,5 +1251,10 @@ { "name": "PricingV1Number" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index 2942e38b..6ca39b70 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -1237,5 +1237,10 @@ { "name": "PricingV2Number" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 2f1bba9c..3af9dd5b 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -45,7 +45,13 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body of message interactions (e.g. `{\"body\": \"hello\"}`) or the call duration (when available) of a call (e.g. `{\"duration\": \"5\"}`)." + "description": "A JSON string that includes the message body of message interactions (e.g. `{\"body\": \"hello\"}`) or the call duration (when available) of a call (e.g. `{\"duration\": \"5\"}`).", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -67,7 +73,7 @@ "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message." + "description": "The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource)." }, "inbound_resource_status": { "type": "string", @@ -211,7 +217,13 @@ "data": { "type": "string", "nullable": true, - "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)" + "description": "A JSON string that includes the message body sent to the participant. (e.g. `{\"body\": \"hello\"}`)", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "type": { "type": "string", @@ -390,7 +402,13 @@ "identifier": { "type": "string", "nullable": true, - "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters." + "description": "The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "proxy_identifier": { "type": "string", @@ -3659,7 +3677,7 @@ "minLength": 34, "maxLength": 34, "pattern": "^SC[0-9a-fA-F]{32}$", - "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service." + "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) resource that represents the short code you would like to assign to your Proxy Service." } }, "required": [ @@ -4065,5 +4083,10 @@ { "name": "ProxyV1ShortCode" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index fb90780a..4139b001 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -622,5 +622,10 @@ { "name": "RoutesV2Trunk" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 692e90d7..d4ee7485 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -37,7 +37,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters." + "description": "The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -103,7 +109,13 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one." + "description": "The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "visibility": { "type": "string", @@ -230,7 +242,8 @@ "node10", "node12", "node14", - "node16" + "node16", + "node18" ] }, "serverless.v1.service.build.build_status": { @@ -383,17 +396,35 @@ "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies the Environment resource." + "description": "A user-defined string that uniquely identifies the Environment resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "domain_suffix": { "type": "string", "nullable": true, - "description": "A URL-friendly name that represents the environment and forms part of the domain name." + "description": "A URL-friendly name that represents the environment and forms part of the domain name.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "domain_name": { "type": "string", "nullable": true, - "description": "The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix." + "description": "The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -451,7 +482,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters." + "description": "The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -517,7 +554,13 @@ "path": { "type": "string", "nullable": true, - "description": "The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one." + "description": "The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "visibility": { "type": "string", @@ -721,12 +764,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Service resource." + "description": "The string that you assigned to describe the Service resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "unique_name": { "type": "string", "nullable": true, - "description": "A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource." + "description": "A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "include_credentials": { "type": "boolean", @@ -807,12 +862,24 @@ "key": { "type": "string", "nullable": true, - "description": "A string by which the Variable resource can be referenced." + "description": "A string by which the Variable resource can be referenced.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "value": { "type": "string", "nullable": true, - "description": "A string that contains the actual value of the Variable." + "description": "A string that contains the actual value of the Variable.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -1554,7 +1621,7 @@ "service_sid": "service_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, "parent": "/Services/{Sid}", @@ -1740,7 +1807,7 @@ "version": "1.0.1" } ], - "runtime": "node16", + "runtime": "node18", "status": "building", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", @@ -1836,7 +1903,7 @@ "service_sid": "service_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, "parent": "/Services/{Sid}", @@ -1915,7 +1982,7 @@ "version": "1.0.1" } ], - "runtime": "node16", + "runtime": "node18", "status": "building", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", @@ -3238,7 +3305,7 @@ "function_sid": "function_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", @@ -3398,7 +3465,7 @@ "function_sid": "function_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", @@ -4833,5 +4900,10 @@ { "name": "ServerlessV1Variable" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index 99d86651..6a001188 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -167,11 +167,23 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`." + "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -225,7 +237,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "flow_sid": { "type": "string", @@ -293,7 +311,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -344,7 +368,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "execution_sid": { "type": "string", @@ -488,7 +518,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -539,7 +575,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "engagement_sid": { "type": "string", @@ -619,7 +661,7 @@ "flow_sid": "flow_sid", "engagement_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -871,7 +913,7 @@ "flow_sid": "flow_sid", "engagement_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -1097,7 +1139,7 @@ "flow_sid": "flow_sid", "execution_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -1367,7 +1409,7 @@ "flow_sid": "flow_sid", "execution_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -1683,7 +1725,7 @@ "execution_sid": "execution_sid", "step_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", @@ -1845,7 +1887,7 @@ "execution_sid": "execution_sid", "step_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", @@ -2309,7 +2351,7 @@ "engagement_sid": "engagement_sid", "step_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Engagements/{Sid}", @@ -2471,7 +2513,7 @@ "engagement_sid": "engagement_sid", "step_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Engagements/{Sid}", @@ -2686,5 +2728,10 @@ { "name": "StudioV1StepContext" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index b708a8a6..a0708c4c 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -37,11 +37,23 @@ "contact_channel_address": { "type": "string", "nullable": true, - "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`." + "description": "The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -95,7 +107,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "flow_sid": { "type": "string", @@ -163,7 +181,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "transitioned_from": { "type": "string", @@ -214,7 +238,13 @@ }, "context": { "nullable": true, - "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution." + "description": "The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "execution_sid": { "type": "string", @@ -518,7 +548,7 @@ "flow_sid": "flow_sid", "execution_sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -786,7 +816,7 @@ "flow_sid": "flow_sid", "execution_sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Context" } }, "parent": "/Flows/{Sid}", @@ -1100,7 +1130,7 @@ "execution_sid": "execution_sid", "step_sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", @@ -1262,7 +1292,7 @@ "execution_sid": "execution_sid", "step_sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context" } }, "parent": "/Flows/{FlowSid}/Executions/{Sid}", @@ -1471,7 +1501,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{sid}/TestUsers" }, "executions": { "mapping": { @@ -1733,7 +1763,7 @@ "mapping": { "sid": "sid" }, - "resource_url": "/v2None" + "resource_url": "/v2/Flows/{sid}/TestUsers" }, "executions": { "mapping": { @@ -2455,5 +2485,10 @@ { "name": "StudioV2FlowValidate" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index 76e02119..ebdc9009 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -95,7 +95,13 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource." + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sim_sid": { "type": "string", @@ -103,13 +109,13 @@ "maxLength": 34, "pattern": "^HS[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) resource that this eSIM Profile controls." + "description": "The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls." }, "status": { "type": "string", "$ref": "#/components/schemas/esim_profile_enum_status", "nullable": true, - "description": "The status of the eSIM Profile. Can be: `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each." + "description": "The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each." }, "eid": { "type": "string", @@ -355,7 +361,13 @@ "payload": { "type": "string", "nullable": true, - "description": "The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.\n\nFor an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message \u201cas is\u201d. The payload should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated." + "description": "The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used.\n\nFor an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message \u201cas is\u201d. The payload should not exceed 1300 bytes.\n\nFor an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -619,7 +631,13 @@ "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM." + "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -731,7 +749,13 @@ "payload": { "type": "string", "nullable": true, - "description": "The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters." + "description": "The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status": { "type": "string", @@ -1261,7 +1285,7 @@ { "name": "SimSid", "in": "query", - "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.", + "description": "Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records.", "schema": { "type": "string" }, @@ -3930,6 +3954,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readByIccid": { "value": "89883070000123456789" @@ -5826,5 +5856,10 @@ { "name": "SupersimV1UsageRecord" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 571128db..4aa304b1 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -21,7 +21,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -58,7 +64,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -81,7 +93,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`." + "description": "The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -115,7 +133,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -167,7 +191,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 7 + } + } }, "date_created": { "type": "string", @@ -239,7 +269,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length." + "description": "An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 0 + } + } } } }, @@ -257,7 +293,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -313,7 +355,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`." + "description": "The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -362,7 +410,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -385,7 +439,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`." + "description": "The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -433,7 +493,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -472,7 +538,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -528,7 +600,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`." + "description": "The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -538,7 +616,13 @@ "key": { "type": "string", "nullable": true, - "description": "The unique, user-defined key for the Map Item." + "description": "The unique, user-defined key for the Map Item.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -577,7 +661,13 @@ }, "data": { "nullable": true, - "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length." + "description": "An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 7 + } + } }, "date_expires": { "type": "string", @@ -600,7 +690,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`." + "description": "The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } }, @@ -648,7 +744,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token." + "description": "The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "read": { "type": "boolean", @@ -687,7 +789,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -738,7 +846,13 @@ "created_by": { "type": "string", "nullable": true, - "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'." + "description": "The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } } } } @@ -1300,6 +1414,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -1367,6 +1487,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -1413,6 +1539,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3405,6 +3537,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3472,6 +3610,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3518,6 +3662,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -4310,6 +4460,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -4380,6 +4536,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -4434,6 +4596,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -4895,6 +5063,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -4962,6 +5136,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -5008,6 +5188,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -5762,5 +5948,10 @@ { "name": "SyncV1SyncStream" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index 4ad80ec8..cdf14740 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -203,12 +203,18 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null." + "description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "addons": { "type": "string", "nullable": true, - "description": "An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) data for all installed addons." + "description": "An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) data for all installed Add-ons." }, "date_created": { "type": "string", @@ -436,7 +442,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "max_reserved_workers": { "type": "integer", @@ -504,7 +516,7 @@ "LIFO" ] }, - "taskrouter.v1.task_queue_bulk_real_time_statistics": { + "taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics": { "type": "object", "properties": { "account_sid": { @@ -527,7 +539,7 @@ "type": "array", "items": {}, "nullable": true, - "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." + "description": "The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes:\n\n`task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated.\n\n`total_available_workers`: The total number of Workers available for Tasks in the TaskQueue.\n\n`total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state.\n\n`total_tasks`: The total number of Tasks.\n\n`longest_task_waiting_age`: The age of the longest waiting Task.\n\n`longest_task_waiting_sid`: The SID of the longest waiting Task.\n\n`tasks_by_status`: The number of Tasks grouped by their current status.\n\n`tasks_by_priority`: The number of Tasks grouped by priority.\n\n`activity_statistics`: The number of current Workers grouped by Activity.\n" }, "task_queue_response_count": { "type": "integer", @@ -984,7 +996,13 @@ "attributes": { "type": "string", "nullable": true, - "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker." + "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 30 + } + } }, "available": { "type": "boolean", @@ -1012,7 +1030,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace." + "description": "The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -1481,7 +1505,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`." + "description": "The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "sid": { "type": "string", @@ -1796,7 +1826,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`." + "description": "The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "multi_task_enabled": { "type": "boolean", @@ -3534,7 +3570,7 @@ { "name": "HasAddons", "in": "query", - "description": "Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.", + "description": "Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.", "schema": { "type": "boolean" } @@ -4357,21 +4393,21 @@ "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" } }, "parent": "/Workspaces/{Sid}", @@ -4432,7 +4468,8 @@ "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", - "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" }, "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -4512,7 +4549,8 @@ "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", - "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" }, "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -4655,21 +4693,21 @@ "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid", "task_queue_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics" } }, "parent": "/Workspaces/{Sid}", @@ -4700,6 +4738,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -4848,7 +4892,8 @@ "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", - "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" }, "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -4932,7 +4977,8 @@ "statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics", "real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics", "cumulative_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics", - "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics" + "list_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics", + "bulk_real_time_statistics": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics" }, "reservation_activity_name": "80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73", "reservation_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -5026,8 +5072,11 @@ "x-twilio": { "defaultOutputProperties": [ "account_sid", - "workspace_sid" + "workspace_sid", + "task_queue_data", + "task_queue_response_count" ], + "parent": "/Workspaces/{WorkspaceSid}/TaskQueues", "mountName": "bulk_real_time_statistics", "className": "task_queue_bulk_real_time_statistics", "pathType": "list" @@ -5056,7 +5105,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/taskrouter.v1.task_queue_bulk_real_time_statistics" + "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics" }, "examples": { "create": { @@ -6635,6 +6684,10 @@ "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`." } } }, @@ -6675,20 +6728,20 @@ "mapping": { "workspace_sid": "workspace_sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics" }, "statistics": { "mapping": { "workspace_sid": "workspace_sid", "worker_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics" }, "reservations": { "mapping": { @@ -6784,6 +6837,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -7124,20 +7183,20 @@ "mapping": { "workspace_sid": "workspace_sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics" }, "statistics": { "mapping": { "workspace_sid": "workspace_sid", "worker_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics" }, "reservations": { "mapping": { @@ -8639,6 +8698,10 @@ "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`." } } }, @@ -9134,21 +9197,21 @@ "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" } }, "parent": "/Workspaces/{Sid}", @@ -9413,21 +9476,21 @@ "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "workspace_sid", "workflow_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics" } }, "parent": "/Workspaces/{Sid}", @@ -9458,6 +9521,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -10207,19 +10276,19 @@ "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/CumulativeStatistics" }, "task_channels": { "mapping": { @@ -10516,19 +10585,19 @@ "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/Statistics" }, "real_time_statistics": { "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/RealTimeStatistics" }, "cumulative_statistics": { "mapping": { "workspace_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Workspaces/{workspace_sid}/CumulativeStatistics" }, "task_channels": { "mapping": { @@ -10552,6 +10621,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readFull": { "value": "friendly_name" @@ -11355,5 +11430,10 @@ { "name": "TaskrouterV1WorkspaceStatistics" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 60a4c909..0d601e43 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -152,7 +152,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema." + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -232,7 +238,13 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the resource." + "description": "The string that you assigned to describe the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "links": { "type": "object", @@ -468,7 +480,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information." + "description": "The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "friendly_name": { "type": "string", @@ -2455,7 +2473,7 @@ "mapping": { "trunk_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Trunks/{trunk_sid}/Recording" } }, "pathType": "instance" @@ -2741,7 +2759,7 @@ "mapping": { "trunk_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Trunks/{trunk_sid}/Recording" } }, "pathType": "list" @@ -3049,5 +3067,10 @@ { "name": "TrunkingV1Trunk" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index de1b02f9..2c20da32 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -33,6 +33,101 @@ } } }, + "trusthub.v1.compliance_registration": { + "type": "object", + "properties": { + "inquiry_id": { + "type": "string", + "nullable": true, + "description": "The unique ID used to start an embedded compliance registration session." + }, + "inquiry_session_token": { + "type": "string", + "nullable": true, + "description": "The session token used to start an embedded compliance registration session." + }, + "registration_id": { + "type": "string", + "nullable": true, + "description": "The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of this resource." + } + } + }, + "compliance_registration_enum_end_user_type": { + "type": "string", + "enum": [ + "Individual", + "Business" + ] + }, + "compliance_registration_enum_phone_number_type": { + "type": "string", + "enum": [ + "local", + "national", + "mobile", + "toll-free" + ] + }, + "compliance_registration_enum_business_identity_type": { + "type": "string", + "enum": [ + "direct_customer", + "isv_reseller_or_partner", + "unknown" + ] + }, + "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": { @@ -331,7 +426,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types." + "description": "The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -465,7 +566,13 @@ }, "attributes": { "nullable": true, - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types." + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -856,6 +963,14 @@ "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" } + }, + "createWithNotificationEmail": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "customer_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize" + } } } } @@ -882,6 +997,10 @@ "maxLength": 34, "pattern": "^BU[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile." + }, + "NotificationEmail": { + "type": "string", + "description": "The email address that approval status updates will be sent to. If not specified, the email address associated with your primary customer profile will be used." } }, "required": [ @@ -893,6 +1012,12 @@ "value": { "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } + }, + "createWithNotificationEmail": { + "value": { + "PrimaryProfileSid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "NotificationEmail": "pfarnsworth@twilio.com" + } } } } @@ -992,6 +1117,440 @@ } } }, + "/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "inquiry_id", + "session_token", + "registration_id" + ], + "mountName": "compliance_registration_inquiries", + "className": "compliance_registration_inquiries", + "pathType": "list" + }, + "post": { + "description": "Create a new Compliance Registration Inquiry for the authenticated account. This is necessary to start a new embedded session.", + "tags": [ + "TrusthubV1ComplianceRegistrationInquiries" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/trusthub.v1.compliance_registration" + }, + "examples": { + "create": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateComplianceRegistration", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateComplianceRegistrationRequest", + "properties": { + "EndUserType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_end_user_type", + "description": "The type of End User the regulation requires - can be `Individual` or `Business`." + }, + "PhoneNumberType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_phone_number_type", + "description": "The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`." + }, + "BusinessIdentityType": { + "type": "string", + "$ref": "#/components/schemas/compliance_registration_enum_business_identity_type", + "description": "The type of business identity. Can be `direct customer` or `ISV`." + }, + "BusinessRegistrationAuthority": { + "type": "string", + "description": "The authority that registered the business" + }, + "BusinessLegalName": { + "type": "string", + "description": "he name of the business or organization using the Tollfree number." + }, + "NotificationEmail": { + "type": "string", + "description": "he email address to receive the notification about the verification result." + }, + "AcceptedNotificationReceipt": { + "type": "boolean", + "description": "The email address to receive the notification about the verification result." + }, + "BusinessRegistrationNumber": { + "type": "string", + "description": "Business registration number of the business" + }, + "BusinessWebsiteUrl": { + "type": "string", + "description": "The URL of the business website" + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name for your business information" + }, + "AuthorizedRepresentative1FirstName": { + "type": "string", + "description": "First name of the authorized representative" + }, + "AuthorizedRepresentative1LastName": { + "type": "string", + "description": "Last name of the authorized representative" + }, + "AuthorizedRepresentative1Phone": { + "type": "string", + "description": "Phone number of the authorized representative" + }, + "AuthorizedRepresentative1Email": { + "type": "string", + "description": "Email address of the authorized representative" + }, + "AuthorizedRepresentative1DateOfBirth": { + "type": "string", + "description": "Birthdate of the authorized representative" + }, + "AddressStreet": { + "type": "string", + "description": "Street address of the business" + }, + "AddressStreetSecondary": { + "type": "string", + "description": "Street address of the business" + }, + "AddressCity": { + "type": "string", + "description": "City of the business" + }, + "AddressSubdivision": { + "type": "string", + "description": "State or province of the business" + }, + "AddressPostalCode": { + "type": "string", + "description": "Postal code of the business" + }, + "AddressCountryCode": { + "type": "string", + "description": "Country code of the business" + }, + "EmergencyAddressStreet": { + "type": "string", + "description": "Street address of the business" + }, + "EmergencyAddressStreetSecondary": { + "type": "string", + "description": "Street address of the business" + }, + "EmergencyAddressCity": { + "type": "string", + "description": "City of the business" + }, + "EmergencyAddressSubdivision": { + "type": "string", + "description": "State or province of the business" + }, + "EmergencyAddressPostalCode": { + "type": "string", + "description": "Postal code of the business" + }, + "EmergencyAddressCountryCode": { + "type": "string", + "description": "Country code of the business" + }, + "UseAddressAsEmergencyAddress": { + "type": "boolean", + "description": "Use the business address as the emergency address" + }, + "FileName": { + "type": "string", + "description": "The name of the verification document to upload" + }, + "File": { + "type": "string", + "description": "The verification document to upload" + } + }, + "required": [ + "EndUserType", + "PhoneNumberType" + ] + }, + "examples": { + "create": { + "value": { + "EndUserType": "Individual", + "PhoneNumberType": "national", + "BusinessLegalName": "Owl, Inc.", + "NotificationEmail": "test@test.com", + "AcceptedNotificationReceipt": true, + "BusinessRegistrationNumber": "123456789", + "BusinessWebsiteUrl": "https://twilio.co", + "FriendlyName": "Owl", + "AuthorizedRepresentative1FirstName": "firstname", + "AuthorizedRepresentative1LastName": "lastname", + "AuthorizedRepresentative1Email": "test@test.com", + "AuthorizedRepresentative1DateOfBirth": "1990-01-01", + "AddressStreet": "123 Main St", + "AddressStreetSecondary": "Apt 1", + "AddressCity": "San Francisco", + "AddressSubdivision": "CA", + "AddressPostalCode": "94107", + "AddressCountryCode": "US", + "UseAddressAsEmergencyAddress": true, + "EmergencyAddressStreet": "123 Main St", + "EmergencyAddressStreetSecondary": "Apt 1", + "EmergencyAddressCity": "San Francisco", + "EmergencyAddressSubdivision": "CA", + "EmergencyAddressPostalCode": "94107", + "EmergencyAddressCountryCode": "US", + "FileName": "fileName", + "File": "file", + "BusinessIdentityType": "direct_customer", + "BusinessRegistrationAuthority": "ein" + } + } + } + } + } + } + } + }, + "/v1/ComplianceInquiries/Tollfree/Initialize": { + "servers": [ + { + "url": "https://trusthub.twilio.com" + } + ], + "description": "", + "x-twilio": { + "defaultOutputProperties": [ + "inquiry_id", + "session_token", + "registration_id" + ], + "mountName": "compliance_tollfree_inquiries", + "className": "compliance_tollfree_inquiries", + "pathType": "list" + }, + "post": { + "description": "Create a new Compliance Tollfree Verification Inquiry for the authenticated account. This is necessary to start a new embedded session.", + "tags": [ + "TrusthubV1ComplianceTollfreeInquiries" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/trusthub.v1.compliance_tollfree_inquiry" + }, + "examples": { + "create": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize" + } + }, + "create2": { + "value": { + "inquiry_id": "inq_aaaaaaaaaaaaaaaaaaaaaaaa", + "inquiry_session_token": "new.session.token", + "registration_id": "tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "url": "https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize" + } + } + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateComplianceTollfreeInquiry", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateComplianceTollfreeInquiryRequest", + "properties": { + "TollfreePhoneNumber": { + "type": "string", + "format": "phone-number", + "description": "The Tollfree phone number to be verified" + }, + "NotificationEmail": { + "type": "string", + "description": "The email address to receive the notification about the verification result." + }, + "BusinessName": { + "type": "string", + "description": "The name of the business or organization using the Tollfree number." + }, + "BusinessWebsite": { + "type": "string", + "description": "The website of the business or organization using the Tollfree number." + }, + "UseCaseCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The category of the use case for the Tollfree Number. List as many are applicable.." + }, + "UseCaseSummary": { + "type": "string", + "description": "Use this to further explain how messaging is used by the business or organization." + }, + "ProductionMessageSample": { + "type": "string", + "description": "An example of message content, i.e. a sample message." + }, + "OptInImageUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL." + }, + "OptInType": { + "type": "string", + "$ref": "#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type", + "description": "Describe how a user opts-in to text messages." + }, + "MessageVolume": { + "type": "string", + "description": "Estimate monthly volume of messages from the Tollfree Number." + }, + "BusinessStreetAddress": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessStreetAddress2": { + "type": "string", + "description": "The address of the business or organization using the Tollfree number." + }, + "BusinessCity": { + "type": "string", + "description": "The city of the business or organization using the Tollfree number." + }, + "BusinessStateProvinceRegion": { + "type": "string", + "description": "The state/province/region of the business or organization using the Tollfree number." + }, + "BusinessPostalCode": { + "type": "string", + "description": "The postal code of the business or organization using the Tollfree number." + }, + "BusinessCountry": { + "type": "string", + "description": "The country of the business or organization using the Tollfree number." + }, + "AdditionalInformation": { + "type": "string", + "description": "Additional information to be provided for verification." + }, + "BusinessContactFirstName": { + "type": "string", + "description": "The first name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactLastName": { + "type": "string", + "description": "The last name of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactEmail": { + "type": "string", + "description": "The email address of the contact for the business or organization using the Tollfree number." + }, + "BusinessContactPhone": { + "type": "string", + "format": "phone-number", + "description": "The phone number of the contact for the business or organization using the Tollfree number." + } + }, + "required": [ + "TollfreePhoneNumber", + "NotificationEmail" + ] + }, + "examples": { + "create": { + "value": { + "TollfreePhoneNumber": "+123445566", + "NotificationEmail": "jeff@twilio.com" + } + }, + "create2": { + "value": { + "TollfreePhoneNumber": "+123445566", + "NotificationEmail": "jeff@twilio.com", + "BusinessName": "Owl, Inc.", + "BusinessStreetAddress": "123 Main Street", + "BusinessStreetAddress2": "Suite 101", + "BusinessCity": "Anytown", + "BusinessStateProvinceRegion": "AA", + "BusinessPostalCode": "11111", + "BusinessCountry": "US", + "BusinessWebsite": "http://www.company.com", + "BusinessContactFirstName": "firstname", + "BusinessContactLastName": "lastname", + "BusinessContactEmail": "email@company.com", + "BusinessContactPhone": "+1231231234", + "UseCaseCategories": [ + "TWO_FACTOR_AUTHENTICATION", + "MARKETING" + ], + "UseCaseSummary": "This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop", + "ProductionMessageSample": "lorem ipsum", + "OptInImageUrls": [ + "https://testbusiness.com/images/image1.jpg", + "https://testbusiness.com/images/image2.jpg" + ], + "OptInType": "VERBAL", + "MessageVolume": "10", + "AdditionalInformation": "see our privacy policy here www.johnscoffeeshop.com/privacypolicy" + } + } + } + } + } + } + } + }, "/v1/CustomerProfiles": { "servers": [ { @@ -7259,6 +7818,12 @@ { "name": "TrusthubV1ComplianceInquiries" }, + { + "name": "TrusthubV1ComplianceRegistrationInquiries" + }, + { + "name": "TrusthubV1ComplianceTollfreeInquiries" + }, { "name": "TrusthubV1CustomerProfiles" }, @@ -7298,5 +7863,10 @@ { "name": "TrusthubV1TrustProductsEvaluations" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index 89f84198..a32d436e 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -48,7 +48,13 @@ "factor_friendly_name": { "type": "string", "nullable": true, - "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name." + "description": "A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "token": { "type": "string", @@ -183,7 +189,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "factor_sid": { "type": "string", @@ -231,15 +243,33 @@ }, "details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be shown to the end user." + "description": "Details provided to give context about the Challenge. Intended to be shown to the end user.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "hidden_details": { "nullable": true, - "description": "Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`" + "description": "Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length." + "description": "Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "factor_type": { "type": "string", @@ -306,7 +336,13 @@ "identity": { "type": "string", "nullable": true, - "description": "The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -388,7 +424,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "date_created": { "type": "string", @@ -425,7 +467,13 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length." + "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -586,7 +634,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "binding": { "nullable": true, @@ -627,7 +681,13 @@ }, "metadata": { "nullable": true, - "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length." + "description": "Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "url": { "type": "string", @@ -705,7 +765,13 @@ "identity": { "type": "string", "nullable": true, - "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters." + "description": "Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "challenge_sid": { "type": "string", @@ -810,7 +876,13 @@ "phone_number": { "type": "string", "nullable": true, - "description": "The phone number in SafeList." + "description": "The phone number in SafeList.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + } }, "url": { "type": "string", @@ -899,6 +971,11 @@ "pattern": "^HJ[0-9a-fA-F]{32}$", "nullable": true }, + "verify_event_subscription_enabled": { + "type": "boolean", + "nullable": true, + "description": "Whether to allow verifications from the service to reach the stream-events sinks if configured" + }, "date_created": { "type": "string", "format": "date-time", @@ -955,13 +1032,19 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)." + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "channel": { "type": "string", "$ref": "#/components/schemas/verification_enum_channel", "nullable": true, - "description": "The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`." + "description": "The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna`, or `rcs`." }, "status": { "type": "string", @@ -980,12 +1063,24 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "send_code_attempts": { "type": "array", @@ -1102,7 +1197,7 @@ }, "price": { "nullable": true, - "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/verify/pricing)." + "description": "An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing)." }, "channel_data": { "nullable": true, @@ -1239,7 +1334,13 @@ "to": { "type": "string", "nullable": true, - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164)." + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "channel": { "type": "string", @@ -1260,12 +1361,24 @@ "amount": { "type": "string", "nullable": true, - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "payee": { "type": "string", "nullable": true, - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled." + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "x-twilio": { + "pii": { + "handling": "sensitive", + "deleteSla": 1 + } + } }, "date_created": { "type": "string", @@ -2279,6 +2392,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -2512,6 +2631,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2781,6 +2906,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -2879,6 +3010,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3357,6 +3494,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3397,6 +3540,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -3480,6 +3629,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3532,6 +3687,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3639,6 +3800,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -3829,6 +3996,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -4032,6 +4205,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true } ], @@ -4781,6 +4960,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "required": true }, { @@ -5455,6 +5640,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "required": true } ], @@ -5499,6 +5690,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 0 + } + }, "required": true } ], @@ -5613,6 +5810,7 @@ "skew": 2 }, "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -5722,6 +5920,10 @@ "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": [ @@ -5746,7 +5948,8 @@ "Totp.TimeStep": 30, "Totp.CodeLength": 3, "Totp.Skew": 2, - "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VerifyEventSubscriptionEnabled": false } } } @@ -5874,6 +6077,7 @@ "skew": null }, "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -6016,6 +6220,7 @@ "skew": null }, "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -6127,6 +6332,7 @@ "skew": 2 }, "default_template_sid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "verify_event_subscription_enabled": false, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", @@ -6236,6 +6442,10 @@ "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" } } }, @@ -6258,7 +6468,8 @@ "Totp.TimeStep": 30, "Totp.CodeLength": 3, "Totp.Skew": 2, - "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + "DefaultTemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "VerifyEventSubscriptionEnabled": false } } } @@ -6567,6 +6778,10 @@ "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": [ @@ -6589,7 +6804,8 @@ "AppHash": "AAAAAAAAAAA", "TemplateSid": "HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "TemplateCustomSubstitutions": "{\"AppName\": \"MyApp\", \"Contact\":\"12345689\"}", - "RiskCheck": "enable" + "RiskCheck": "enable", + "Tags": "{\"tenant_id\": \"12345\"}" } }, "createVerificationWhatsapp": { @@ -6916,6 +7132,12 @@ "description": "Destination of a verification. It is phone number in E.164 format.", "schema": { "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } } }, { @@ -8296,5 +8518,10 @@ { "name": "VerifyV2Webhook" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index c36f36c7..60a47108 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -64,7 +64,13 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`." + "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "audio_sources_excluded": { "type": "array", @@ -72,11 +78,23 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." + "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "video_layout": { "nullable": true, - "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." + "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "resolution": { "type": "string", @@ -214,7 +232,13 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" + "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "audio_sources_excluded": { "type": "array", @@ -222,11 +246,23 @@ "type": "string" }, "nullable": true, - "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." + "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "video_layout": { "nullable": true, - "description": "A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" + "description": "A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "resolution": { "type": "string", @@ -307,7 +343,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", @@ -416,7 +452,13 @@ "track_name": { "type": "string", "nullable": true, - "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used." + "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "offset": { "type": "integer", @@ -519,7 +561,7 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", @@ -1341,7 +1383,7 @@ "mapping": { "composition_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Compositions/{composition_sid}/Media" } }, "pathType": "instance" @@ -1503,7 +1545,7 @@ "mapping": { "composition_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Compositions/{composition_sid}/Media" } }, "pathType": "list" @@ -2831,7 +2873,7 @@ "AwsS3Url": { "type": "string", "format": "uri", - "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", @@ -2884,7 +2926,7 @@ "mapping": { "recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Recordings/{recording_sid}/Media" } }, "pathType": "instance" @@ -3011,7 +3053,7 @@ "mapping": { "recording_sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Recordings/{recording_sid}/Media" } }, "pathType": "list" @@ -3398,7 +3440,7 @@ "AwsS3Url": { "type": "string", "format": "uri", - "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the RFC 3986." + "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", @@ -4301,7 +4343,7 @@ "room_sid": "room_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, "parent": "/Rooms/{Sid}", @@ -4506,7 +4548,7 @@ "room_sid": "room_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, "parent": "/Rooms/{Sid}", @@ -5457,7 +5499,7 @@ "room_sid": "room_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" } }, "parent": "/Rooms/{Sid}", @@ -5610,7 +5652,7 @@ "room_sid": "room_sid", "sid": "sid" }, - "resource_url": "/v1None" + "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" } }, "parent": "/Rooms/{Sid}", @@ -6028,5 +6070,10 @@ { "name": "VideoV1SubscribedTrack" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 04ccf989..e472a6be 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -60,7 +60,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call." + "description": "The URL we call using the `voice_method` when the BYOC Trunk receives a call.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_method": { "type": "string", @@ -80,7 +86,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`." + "description": "The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "voice_fallback_method": { "type": "string", @@ -100,7 +112,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The URL that we call to pass status parameters (such as call ended) to your application." + "description": "The URL that we call to pass status parameters (such as call ended) to your application.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "status_callback_method": { "type": "string", @@ -243,7 +261,13 @@ "type": "string", "format": "uri", "nullable": true, - "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported." + "description": "The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "priority": { "type": "integer", @@ -464,7 +488,13 @@ "ip_address": { "type": "string", "nullable": true, - "description": "An IP address in dotted decimal notation, IPv4 only." + "description": "An IP address in dotted decimal notation, IPv4 only.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "cidr_prefix_length": { "type": "integer", @@ -3589,5 +3619,10 @@ { "name": "VoiceV1SourceIpMapping" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index 2d48987d..1b3c8c55 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -70,7 +70,13 @@ "command": { "type": "string", "nullable": true, - "description": "The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64." + "description": "The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "command_mode": { "type": "string", @@ -360,7 +366,13 @@ "unique_name": { "type": "string", "nullable": true, - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource." + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "account_sid": { "type": "string", @@ -381,12 +393,24 @@ "friendly_name": { "type": "string", "nullable": true, - "description": "The string that you assigned to describe the Sim resource." + "description": "The string that you assigned to describe the Sim resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "iccid": { "type": "string", "nullable": true, - "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM." + "description": "The [ICCID](https://en.wikipedia.org/wiki/SIM_card#ICCID) associated with the SIM.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } }, "e_id": { "type": "string", @@ -2532,6 +2556,12 @@ "schema": { "type": "string" }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + }, "examples": { "readEmpty": { "value": "iccid" @@ -2979,5 +3009,10 @@ { "name": "WirelessV1UsageRecord" } + ], + "security": [ + { + "accountSid_authToken": [] + } ] } \ No newline at end of file diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index e6f3a3cf..5ffc3e7a 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -20,6 +20,10 @@ components: nullable: true description: The promoted Auth Token that must be used to authenticate future API requests. + x-twilio: + pii: + handling: sensitive + deleteSla: 0 date_created: type: string format: date-time @@ -62,6 +66,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 date_created: type: string format: date-time @@ -102,6 +110,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 date_created: type: string format: date-time @@ -134,6 +146,10 @@ 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: @@ -162,6 +178,10 @@ 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 @@ -833,6 +853,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 examples: fetch: value: '+18001234567' @@ -862,6 +886,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 examples: delete: value: '+18001234567' @@ -922,3 +950,5 @@ tags: - name: AccountsV1PublicKey - name: AccountsV1Safelist - name: AccountsV1SecondaryAuthToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index caf2cf98..76d66502 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -12,6 +12,10 @@ components: nullable: true description: The authorization token for this account. This token should be kept a secret, so no sharing. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -29,6 +33,10 @@ components: nullable: true description: A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address. + x-twilio: + pii: + handling: standard + deleteSla: 30 owner_account_sid: type: string minLength: 34 @@ -66,6 +74,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Account")' account_enum_status: type: string enum: @@ -97,6 +106,10 @@ components: nullable: true description: The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -113,6 +126,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 iso_country: type: string format: iso-country-code @@ -122,6 +139,10 @@ components: type: string nullable: true description: The postal code of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 region: type: string nullable: true @@ -138,6 +159,10 @@ components: type: string nullable: true description: The number and street address of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 uri: type: string nullable: true @@ -165,6 +190,11 @@ components: type: string nullable: true description: The additional number and street address of the address. + x-twilio: + pii: + handling: standard + deleteSla: 30 + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Address")' api.v2010.account.application: type: object properties: @@ -325,6 +355,7 @@ components: nullable: true description: 'Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Application")' api.v2010.account.authorized_connect_app: type: object properties: @@ -360,18 +391,6 @@ components: pattern: ^CN[0-9a-fA-F]{32}$ nullable: true description: The SID that we assigned to the Connect App. - date_created: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date and time in GMT that the resource was created specified - in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - date_updated: - type: string - format: date-time-rfc-2822 - nullable: true - description: The date and time in GMT that the resource was last updated - specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. permissions: type: array items: @@ -384,6 +403,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthorizedConnectApp")' authorized_connect_app_enum_permission: type: string enum: @@ -419,6 +439,7 @@ components: nullable: true description: A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumberCountry")' api.v2010.account.available_phone_number_country.available_phone_number_local: type: object properties: @@ -506,6 +527,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Local")' api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine: type: object properties: @@ -593,6 +615,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "MachineToMachine")' api.v2010.account.available_phone_number_country.available_phone_number_mobile: type: object properties: @@ -680,6 +703,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Mobile")' api.v2010.account.available_phone_number_country.available_phone_number_national: type: object properties: @@ -767,6 +791,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "National")' api.v2010.account.available_phone_number_country.available_phone_number_shared_cost: type: object properties: @@ -854,6 +879,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SharedCost")' api.v2010.account.available_phone_number_country.available_phone_number_toll_free: type: object properties: @@ -941,6 +967,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "TollFree")' api.v2010.account.available_phone_number_country.available_phone_number_voip: type: object properties: @@ -1028,6 +1055,7 @@ components: description: 'The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Voip")' api.v2010.account.balance: type: object properties: @@ -1048,6 +1076,7 @@ components: type: string nullable: true description: The units of currency for the account balance + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Balance")' api.v2010.account.call: type: object properties: @@ -1093,6 +1122,10 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. + x-twilio: + pii: + handling: standard + deleteSla: 120 to_formatted: type: string nullable: true @@ -1100,6 +1133,10 @@ components: this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). + x-twilio: + pii: + handling: standard + deleteSla: 120 from: type: string nullable: true @@ -1108,12 +1145,20 @@ components: format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`. + x-twilio: + pii: + handling: standard + deleteSla: 120 from_formatted: type: string nullable: true description: The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750). + x-twilio: + pii: + handling: standard + deleteSla: 120 phone_number_sid: type: string minLength: 34 @@ -1186,6 +1231,10 @@ components: description: The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. + x-twilio: + pii: + handling: standard + deleteSla: 120 group_sid: type: string minLength: 34 @@ -1199,6 +1248,10 @@ components: nullable: true description: The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. + x-twilio: + pii: + handling: standard + deleteSla: 120 queue_time: type: string nullable: true @@ -1222,6 +1275,7 @@ components: nullable: true description: A list of subresources available to this call, identified by their URIs relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Call")' call_enum_event: type: string enum: @@ -1251,10 +1305,19 @@ components: request: nullable: true description: Contains a dictionary representing the request of the call. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 response: nullable: true description: Contains a dictionary representing the call response, including a list of the call events. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Event")' api.v2010.account.call.call_feedback: type: object properties: @@ -1300,6 +1363,7 @@ components: pattern: ^CA[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Feedback")' call_feedback_enum_issues: type: string enum: @@ -1392,6 +1456,7 @@ components: nullable: true description: The status of the feedback summary can be `queued`, `in-progress`, `completed`, or `failed`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "FeedbackSummary")' call_feedback_summary_enum_status: type: string enum: @@ -1497,6 +1562,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notification")' api.v2010.account.call.call_notification-instance: type: object properties: @@ -1721,6 +1787,7 @@ components: type: string nullable: true description: 'The recorded track. Can be: `inbound`, `outbound`, or `both`.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' call_recording_enum_status: type: string enum: @@ -1818,6 +1885,7 @@ components: pattern: ^CA[0-9a-fA-F]{32}$ nullable: true description: The call SID that caused the conference to end. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Conference")' conference_enum_status: type: string enum: @@ -1943,6 +2011,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' conference_recording_enum_status: type: string enum: @@ -1979,10 +2048,18 @@ components: nullable: true description: The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 company_name: type: string nullable: true description: The company name set for the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 deauthorize_callback_method: type: string format: http-method @@ -2001,20 +2078,36 @@ components: nullable: true description: The URL we call using the `deauthorize_callback_method` to de-authorize the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 description: type: string nullable: true description: The description of the Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 homepage_url: type: string format: uri nullable: true description: The public URL where users can obtain more information about this Connect App. + x-twilio: + pii: + handling: standard + deleteSla: 30 permissions: type: array items: @@ -2034,6 +2127,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ConnectApp")' connect_app_enum_permission: type: string enum: @@ -2063,6 +2157,10 @@ components: format: phone-number nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -2245,6 +2343,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "DependentPhoneNumber")' dependent_phone_number_enum_address_requirement: type: string enum: @@ -2322,6 +2421,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -2521,6 +2624,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumber")' incoming_phone_number_enum_address_requirement: type: string enum: @@ -2576,6 +2680,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 description: type: string nullable: true @@ -2611,6 +2719,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOn")' ? api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension : type: object properties: @@ -2647,6 +2756,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 product_name: type: string nullable: true @@ -2666,6 +2779,7 @@ components: type: boolean nullable: true description: Whether the Extension will be invoked. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOnExtension")' api.v2010.account.incoming_phone_number.incoming_phone_number_local: type: object properties: @@ -2731,6 +2845,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -2929,6 +3047,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Local")' incoming_phone_number_local_enum_address_requirement: type: string enum: @@ -3020,6 +3139,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3218,6 +3341,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Mobile")' incoming_phone_number_mobile_enum_address_requirement: type: string enum: @@ -3309,6 +3433,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity_sid: type: string minLength: 34 @@ -3507,6 +3635,7 @@ components: status: type: string nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "TollFree")' incoming_phone_number_toll_free_enum_address_requirement: type: string enum: @@ -3548,6 +3677,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3560,6 +3693,7 @@ components: nullable: true description: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Key")' api.v2010.account.message.media: type: object properties: @@ -3608,6 +3742,7 @@ components: type: string nullable: true description: The URI of this Media resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Media")' api.v2010.account.queue.member: type: object properties: @@ -3643,6 +3778,7 @@ components: pattern: ^QU[0-9a-fA-F]{32}$ nullable: true description: The SID of the Queue the member is in. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Member")' api.v2010.account.message: type: object properties: @@ -3650,6 +3786,10 @@ 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 @@ -3671,19 +3811,28 @@ 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/send-messages#use-an-alphanumeric-sender-id), + 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/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. + [short code](https://www.twilio.com/en-us/messaging/channels/sms/short-codes), + or [channel address](https://www.twilio.com/docs/messaging/channels) + (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number + or channel address of the sender. For outgoing messages, this value is + a Twilio phone number, alphanumeric sender ID, short code, or channel + address from which the message is sent. + x-twilio: + pii: + handling: standard + deleteSla: 120 to: type: string nullable: true description: The 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 @@ -3780,6 +3929,7 @@ components: nullable: true description: A list of related resources identified by their URIs relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Message")' message_enum_status: type: string enum: @@ -3856,7 +4006,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/sms/send-message-feedback-to-twilio).' + with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-feedback-to-twilio).' date_created: type: string format: date-time-rfc-2822 @@ -3875,6 +4025,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Feedback")' message_feedback_enum_outcome: type: string enum: @@ -3896,6 +4047,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3915,6 +4070,7 @@ components: to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.** + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "NewKey")' api.v2010.account.new_signing_key: type: object properties: @@ -3930,6 +4086,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -3949,6 +4109,7 @@ components: to authenticate to the REST API (you will use this as the basic-auth `password`). **Note that for security reasons, this field is ONLY returned when the API Key is first created.** + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "NewSigningKey")' api.v2010.account.notification: type: object properties: @@ -4049,6 +4210,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notification")' api.v2010.account.notification-instance: type: object properties: @@ -4190,6 +4352,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -4205,10 +4371,15 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 uri: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "OutgoingCallerId")' api.v2010.account.conference.participant: type: object properties: @@ -4300,6 +4471,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Participant")' participant_enum_status: type: string enum: @@ -4352,6 +4524,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payment")' payments_enum_payment_method: type: string enum: @@ -4435,6 +4608,7 @@ components: nullable: true description: ' The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Queue")' api.v2010.account.recording: type: object properties: @@ -4553,6 +4727,7 @@ components: nullable: true description: The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recording")' recording_enum_status: type: string enum: @@ -4643,6 +4818,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AddOnResult")' recording_add_on_result_enum_status: type: string enum: @@ -4727,6 +4903,7 @@ components: format: uri-map nullable: true description: A list of related resources identified by their relative URIs. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payload")' api.v2010.account.recording.recording_transcription: type: object properties: @@ -4796,6 +4973,10 @@ components: type: string nullable: true description: The text content of the transcription. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string nullable: true @@ -4804,6 +4985,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcription")' recording_transcription_enum_status: type: string enum: @@ -4897,6 +5079,7 @@ components: type: string nullable: true description: The URI of this resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ShortCode")' api.v2010.account.signing_key: type: object properties: @@ -4917,15 +5100,19 @@ components: type: string format: date-time-rfc-2822 nullable: true + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SigningKey")' api.v2010.account.sip: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Sip")' api.v2010.account.sip.sip_domain.sip_auth: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypes")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypeCalls")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping: type: object properties: @@ -4953,6 +5140,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -4961,6 +5152,7 @@ components: nullable: true description: The unique string that that we created to identify the CredentialListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthCallsCredentialListMapping")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping: type: object properties: @@ -4988,6 +5180,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -4996,9 +5192,11 @@ components: nullable: true description: The unique string that that we created to identify the IpAccessControlListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthCallsIpAccessControlListMapping")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthTypeRegistrations")' api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping: type: object properties: @@ -5026,6 +5224,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 0 sid: type: string minLength: 34 @@ -5034,6 +5236,7 @@ components: nullable: true description: The unique string that that we created to identify the CredentialListMapping resource. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthRegistrationsCredentialListMapping")' api.v2010.account.sip.sip_credential_list.sip_credential: type: object properties: @@ -5063,6 +5266,10 @@ components: type: string nullable: true description: The username for this credential. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time-rfc-2822 @@ -5081,6 +5288,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Credential")' api.v2010.account.sip.sip_credential_list: type: object properties: @@ -5127,6 +5335,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialList")' api.v2010.account.sip.sip_domain.sip_credential_list_mapping: type: object properties: @@ -5175,6 +5384,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialListMapping")' api.v2010.account.sip.sip_domain: type: object properties: @@ -5250,6 +5460,10 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_method: type: string format: http-method @@ -5282,12 +5496,20 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_url: type: string format: uri nullable: true description: The URL we call using the `voice_method` when the domain receives a call. + x-twilio: + pii: + handling: standard + deleteSla: 30 subresource_uris: type: object format: uri-map @@ -5328,6 +5550,7 @@ components: description: Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Domain")' api.v2010.account.sip.sip_ip_access_control_list: type: object properties: @@ -5374,6 +5597,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlList")' api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping: type: object properties: @@ -5422,6 +5646,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlListMapping")' api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address: type: object properties: @@ -5482,6 +5707,7 @@ components: type: string nullable: true description: The URI for this resource, relative to `https://api.twilio.com` + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAddress")' api.v2010.account.call.siprec: type: object properties: @@ -5528,6 +5754,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Siprec")' siprec_enum_track: type: string enum: @@ -5604,6 +5831,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Stream")' stream_enum_track: type: string enum: @@ -5673,6 +5901,7 @@ components: type: string nullable: true description: The temporary username that uniquely identifies a Token. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Token")' api.v2010.account.transcription: type: object properties: @@ -5742,6 +5971,10 @@ components: type: string nullable: true description: The text content of the transcription. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string nullable: true @@ -5750,6 +5983,7 @@ components: type: string nullable: true description: The URI of the resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcription")' transcription_enum_status: type: string enum: @@ -5759,6 +5993,7 @@ components: api.v2010.account.usage: type: object properties: {} + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Usage")' api.v2010.account.usage.usage_record: type: object properties: @@ -5840,6 +6075,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Record")' usage_record_enum_category: type: string enum: @@ -6173,6 +6409,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AllTime")' usage_record_all_time_enum_category: type: string enum: @@ -6506,6 +6743,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Daily")' usage_record_daily_enum_category: type: string enum: @@ -6839,6 +7077,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "LastMonth")' usage_record_last_month_enum_category: type: string enum: @@ -7172,6 +7411,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Monthly")' usage_record_monthly_enum_category: type: string enum: @@ -7505,6 +7745,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ThisMonth")' usage_record_this_month_enum_category: type: string enum: @@ -7838,6 +8079,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Today")' usage_record_today_enum_category: type: string enum: @@ -8171,6 +8413,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Yearly")' usage_record_yearly_enum_category: type: string enum: @@ -8504,6 +8747,7 @@ components: nullable: true description: The units in which `usage` is measured, such as `minutes` for calls or `messages` for SMS. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Yesterday")' usage_record_yesterday_enum_category: type: string enum: @@ -8790,6 +9034,10 @@ components: nullable: true description: The URL we call using the `callback_method` when the trigger fires. + x-twilio: + pii: + handling: sensitive + deleteSla: 60 current_value: type: string nullable: true @@ -8859,6 +9107,7 @@ components: nullable: true description: The URI of the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource this trigger watches, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Trigger")' usage_trigger_enum_usage_category: type: string enum: @@ -9156,6 +9405,7 @@ components: nullable: true description: The date that this User Defined Message was created, given in RFC 2822 format. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UserDefinedMessage")' api.v2010.account.call.user_defined_message_subscription: type: object properties: @@ -9195,6 +9445,7 @@ components: nullable: true description: The URI of the User Defined Message Subscription Resource, relative to `https://api.twilio.com`. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UserDefinedMessageSubscription")' api.v2010.account.validation_request: type: object properties: @@ -9218,6 +9469,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -9225,11 +9480,16 @@ components: description: The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 validation_code: type: string nullable: true description: The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called. + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ValidationRequest")' info: title: Twilio - Api description: This is the public Twilio REST API. @@ -9429,6 +9689,10 @@ paths: match this name. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: friendly_name @@ -9474,26 +9738,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAccountResponse @@ -9502,6 +9800,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Account") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Account")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Accounts")' examples: readEmpty: value: @@ -9985,6 +10287,10 @@ paths: description: The `customer_name` of the Address resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: customer_name @@ -9995,6 +10301,10 @@ paths: description: The string that identifies the Address resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -10039,26 +10349,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAddressResponse @@ -10067,6 +10411,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.address' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Address") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Address")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Addresses")' examples: readFull: value: @@ -10579,26 +10927,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListApplicationResponse @@ -10607,6 +10989,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.application' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Application") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Application")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Applications")' examples: readFull: value: @@ -11007,8 +11393,6 @@ paths: connect_app_friendly_name: aaa connect_app_homepage_url: http://www.google.com connect_app_sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: Tue, 31 Aug 2010 20:36:28 +0000 - date_updated: Tue, 31 Aug 2010 20:36:44 +0000 permissions: - get-all uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json @@ -11070,26 +11454,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAuthorizedConnectAppResponse @@ -11098,45 +11516,41 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthorizedConnectApp") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthorizedConnectApp")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AuthorizedConnectApps")' examples: readFull: value: authorized_connect_apps: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - connect_app_company_name: YOUR OTHER MOM + connect_app_company_name: aaa connect_app_description: alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj - connect_app_friendly_name: YOUR MOM + connect_app_friendly_name: aaa connect_app_homepage_url: http://www.google.com connect_app_sid: CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: Tue, 31 Aug 2010 20:36:28 +0000 - date_updated: Tue, 31 Aug 2010 20:36:44 +0000 permissions: - get-all uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json end: 0 first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 - last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 - next_page_uri: null - num_pages: 1 + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=2&PageSize=50 page: 0 page_size: 50 - previous_page_uri: null + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=1&PageSize=50 start: 0 - total: 1 uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json readEmpty: value: authorized_connect_apps: [] end: 0 first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 - last_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50 next_page_uri: null - num_pages: 1 page: 0 page_size: 50 previous_page_uri: null start: 0 - total: 1 uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json description: OK security: @@ -11233,26 +11647,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberCountryResponse @@ -11261,6 +11709,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AvailablePhoneNumberCountry") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AvailablePhoneNumberCountry")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Countries")' examples: readFull: value: @@ -11559,26 +12011,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberLocalResponse @@ -11587,6 +12073,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Local") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Local")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -11802,26 +12292,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberMachineToMachineResponse @@ -11830,6 +12354,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' + x-field-extra-annotation: '@JacksonXmlProperty(localName="MachineToMachine") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="MachineToMachine")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -12045,26 +12573,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberMobileResponse @@ -12073,6 +12635,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Mobile") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Mobile")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -12288,26 +12854,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberNationalResponse @@ -12316,6 +12916,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' + x-field-extra-annotation: '@JacksonXmlProperty(localName="National") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="National")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -12531,26 +13135,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberSharedCostResponse @@ -12559,6 +13197,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' + x-field-extra-annotation: '@JacksonXmlProperty(localName="SharedCost") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="SharedCost")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -12774,26 +13416,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberTollFreeResponse @@ -12802,6 +13478,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' + x-field-extra-annotation: '@JacksonXmlProperty(localName="TollFree") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="TollFree")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -13017,26 +13697,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListAvailablePhoneNumberVoipResponse @@ -13045,6 +13759,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Voip") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Voip")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AvailablePhoneNumbers")' examples: readFull: value: @@ -13144,7 +13862,7 @@ paths: mapping: account_sid: account_sid call_sid: sid - resource_url: /2010-04-01None + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Feedback.json events: mapping: account_sid: account_sid @@ -13649,6 +14367,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 examples: readFullPage1: value: '+123456789' @@ -13667,6 +14389,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 examples: readFullPage1: value: '+987654321' @@ -13773,26 +14499,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListCallResponse @@ -13801,6 +14561,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.call' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Call") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Call")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Calls")' examples: readFullPage1: value: @@ -14036,7 +14800,7 @@ paths: mapping: account_sid: account_sid call_sid: sid - resource_url: /2010-04-01None + resource_url: /2010-04-01/Accounts/{account_sid}/Calls/{call_sid}/Feedback.json events: mapping: account_sid: account_sid @@ -14549,26 +15313,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListCallEventResponse @@ -14577,6 +15375,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.call.call_event' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Event") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Event")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Events")' examples: readFull: value: @@ -15144,26 +15946,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListCallNotificationResponse @@ -15172,6 +16008,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.call.call_notification' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Notification") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Notification")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notifications")' examples: readFull: value: @@ -15448,26 +16288,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListCallRecordingResponse @@ -15476,6 +16350,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.call.call_recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' examples: readFull: value: @@ -16096,26 +16974,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListConferenceResponse @@ -16124,6 +17036,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.conference' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Conference") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Conference")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Conferences")' examples: readEmpty: value: @@ -16570,26 +17486,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListConferenceRecordingResponse @@ -16598,6 +17548,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' examples: readFull: value: @@ -17114,26 +18068,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListConnectAppResponse @@ -17142,6 +18130,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.connect_app' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ConnectApp") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ConnectApp")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ConnectApps")' examples: readFull: value: @@ -17159,10 +18151,10 @@ paths: uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json end: 0 first_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=0&PageSize=50 - next_page_uri: null + next_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=2&PageSize=50 page: 0 page_size: 50 - previous_page_uri: null + previous_page_uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json?Page=1&PageSize=50 start: 0 uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConnectApps.json readEmpty: @@ -17243,26 +18235,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListDependentPhoneNumberResponse @@ -17271,6 +18297,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' + x-field-extra-annotation: '@JacksonXmlProperty(localName="DependentPhoneNumber") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="DependentPhoneNumber")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "DependentPhoneNumbers")' examples: readFull: value: @@ -17791,6 +18821,10 @@ paths: read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -17842,26 +18876,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberResponse @@ -17870,6 +18938,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IncomingPhoneNumber") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IncomingPhoneNumber")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' examples: readFull: value: @@ -18420,26 +19492,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberAssignedAddOnResponse @@ -18448,6 +19554,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOn") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOn")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AssignedAddOns")' examples: readFull: value: @@ -18709,26 +19819,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse @@ -18737,6 +19881,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOnExtension") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AssignedAddOnExtension")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Extensions")' examples: readFull: value: @@ -18815,6 +19963,10 @@ paths: description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -18866,26 +20018,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberLocalResponse @@ -18894,6 +20080,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Local") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Local")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' examples: readFull: value: @@ -19279,6 +20469,10 @@ paths: description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -19330,26 +20524,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberMobileResponse @@ -19358,6 +20586,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Mobile") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Mobile")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' examples: readFull: value: @@ -19742,6 +20974,10 @@ paths: description: A string that identifies the resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -19793,26 +21029,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListIncomingPhoneNumberTollFreeResponse @@ -19821,6 +21091,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' + x-field-extra-annotation: '@JacksonXmlProperty(localName="TollFree") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="TollFree")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IncomingPhoneNumbers")' examples: readFull: value: @@ -20358,26 +21632,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListKeyResponse @@ -20386,6 +21694,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.key' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Key") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Key")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Keys")' examples: readFull: value: @@ -20689,26 +22001,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListMediaResponse @@ -20717,6 +22063,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.message.media' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Media") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Media")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "MediaList")' examples: readFull: value: @@ -20985,26 +22335,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListMemberResponse @@ -21013,6 +22397,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.queue.member' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Member") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Member")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "QueueMembers")' examples: readFull: value: @@ -21098,20 +22486,20 @@ paths: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa api_version: '2010-04-01' body: "Hello! \U0001F44D" - date_created: Thu, 30 Jul 2015 20:12:31 +0000 - date_sent: Thu, 30 Jul 2015 20:12:33 +0000 - date_updated: Thu, 30 Jul 2015 20:12:33 +0000 + date_created: Thu, 24 Aug 2023 05:01:45 +0000 + date_sent: Thu, 24 Aug 2023 05:01:45 +0000 + date_updated: Thu, 24 Aug 2023 05:01:45 +0000 direction: outbound-api error_code: null error_message: null from: '+14155552345' - messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa num_media: '0' num_segments: '1' price: null price_unit: null + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: sent + status: queued subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json tags: @@ -21137,10 +22525,10 @@ paths: price: null price_unit: null sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: sent + status: queued subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: '+14155552345' uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json createWithMessagingService: @@ -21161,10 +22549,10 @@ paths: price: null price_unit: null sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: sent + status: queued subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: '+14155552345' uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json createWithQueuedStatus: @@ -21188,7 +22576,7 @@ paths: status: queued subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: '+14155552345' uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json createScheduledMessageSms: @@ -21209,10 +22597,10 @@ paths: price: null price_unit: null sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: scheduled + status: queued subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: '+15558675310' uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json createScheduledMessageMms: @@ -21233,10 +22621,10 @@ paths: price: null price_unit: null sid: MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: scheduled + status: accepted subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: '+15558675310' uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/MMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json createScheduledMessageWhatsapp: @@ -21260,7 +22648,7 @@ paths: status: scheduled subresource_uris: media: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json - tags: {} + tags: null to: whatsapp:+15558675310 uri: /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json description: Created @@ -21349,7 +22737,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/how-to-configure-link-shortening) + 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 @@ -21380,17 +22768,16 @@ paths: RiskCheck: type: string $ref: '#/components/schemas/message_enum_risk_check' - 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.' + description: 'For SMS pumping protection feature only: Include this + parameter with a value of `disable` to skip any kind of risk check + on the respective message request.' From: type: string format: phone-number description: 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), + 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/docs/sms/api/short-code), + [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 @@ -21426,7 +22813,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/sms/accepted-mime-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) @@ -21456,14 +22843,8 @@ paths: - https://c1.staticflickr.com/3/2899/14341091933_1e92e62d12_b.jpg PersistentAction: - mailto:test@example.com - TransientAction: - - reply:Tell me more StatusCallback: https://example.com To: '+14155552345' - Title: An exciting example - RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": - "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' - TrafficType: free Tags: '{"campaign_name": "Spring Sale 2022","message_type": "cart_abandoned"}' createWoService: value: @@ -21474,14 +22855,8 @@ paths: - https://example.com PersistentAction: - mailto:test@example.com - TransientAction: - - reply:Tell me more StatusCallback: https://example.com To: '+14155552345' - Title: An exciting example - RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": - "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' - TrafficType: free createWithMessagingService: value: ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -21491,16 +22866,9 @@ paths: - https://example.com PersistentAction: - mailto:test@example.com - TransientAction: - - reply:Tell me more StatusCallback: https://example.com To: '+14155552345' - Title: An exciting example - RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": - "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - ContentVariables: '{"1": "name","2": "owl.png"}' - TrafficType: free createWithQueuedStatus: value: ApplicationSid: APaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -21510,29 +22878,22 @@ paths: - https://example.com PersistentAction: - mailto:test@example.com - TransientAction: - - reply:Tell me more StatusCallback: https://example.com To: '+14155552345' - Title: An exciting example - RichLinkData: '{"previewUrl": "https://www.apple.com/","imageUrl": - "https://www.apple.com/v/ipad-pro/o/images/overview/hero_medium_2x.jpg"}' - TrafficType: free createScheduledMessageSms: value: Body: "Hello! \U0001F44D" MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ScheduleType: fixed - SendAt: '2021-11-29T23:50:00Z' StatusCallback: https://example.com To: '+15558675310' createScheduledMessageMms: value: Body: "Hello! \U0001F44D" - MediaUrl: https://example.com + MediaUrl: + - https://example.com MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ScheduleType: fixed - SendAt: '2021-11-29T23:50:00Z' StatusCallback: https://example.com To: '+15558675310' createScheduledMessageWhatsapp: @@ -21540,9 +22901,8 @@ paths: Body: "Hello! \U0001F44D" MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ScheduleType: fixed - SendAt: '2021-11-29T23:50:00Z' StatusCallback: https://example.com - To: whatsapp:+15558675310 + To: 94287277+15558675310 x-twilio: conditional: - - from @@ -21573,6 +22933,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 examples: readFullPage1: value: '+123456789' @@ -21596,6 +22960,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 120 examples: readFullPage1: value: '+987654321' @@ -21652,26 +23020,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListMessageResponse @@ -21680,6 +23082,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.message' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Message") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Message")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Messages")' examples: readFullPage1: value: @@ -22220,26 +23626,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSigningKeyResponse @@ -22248,6 +23688,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.signing_key' + x-field-extra-annotation: '@JacksonXmlProperty(localName="SigningKey") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="SigningKey")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "SigningKeys")' examples: readFull: value: @@ -22447,26 +23891,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListNotificationResponse @@ -22475,6 +23953,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.notification' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Notification") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Notification")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Notifications")' examples: readFull: value: @@ -22701,12 +24183,20 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: FriendlyName in: query description: The string that identifies the OutgoingCallerId resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -22735,26 +24225,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListOutgoingCallerIdResponse @@ -22763,6 +24287,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' + x-field-extra-annotation: '@JacksonXmlProperty(localName="OutgoingCallerId") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="OutgoingCallerId")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "OutgoingCallerIds")' examples: readFull: value: @@ -23830,6 +25358,14 @@ 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 @@ -23848,6 +25384,7 @@ paths: Record: true Trim: do-not-trim TimeLimit: 3600 + CallToken: call-token-string MachineDetection: enable MachineDetectionTimeout: 15 MachineDetectionSpeechThreshold: 3000 @@ -23875,6 +25412,7 @@ paths: Record: true Trim: do-not-trim TimeLimit: 3600 + CallToken: call-token-string MachineDetection: enable MachineDetectionTimeout: 15 MachineDetectionSpeechThreshold: 3000 @@ -24079,26 +25617,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListParticipantResponse @@ -24107,6 +25679,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.conference.participant' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Participant") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Participant")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Participants")' examples: readEmpty: value: @@ -24769,26 +26345,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListQueueResponse @@ -24797,6 +26407,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.queue' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Queue") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Queue")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Queues")' examples: readFull: value: @@ -25199,26 +26813,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListRecordingResponse @@ -25227,6 +26875,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.recording' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Recording") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Recording")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Recordings")' examples: readFull: value: @@ -25525,26 +27177,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListRecordingAddOnResultResponse @@ -25553,6 +27239,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AddOnResult") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AddOnResult")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "AddOnResults")' examples: readFull: value: @@ -25607,7 +27297,7 @@ paths: reference_sid: reference_sid add_on_result_sid: add_on_result_sid payload_sid: sid - resource_url: /2010-04-01None + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json pathType: instance get: @@ -25745,7 +27435,7 @@ paths: reference_sid: reference_sid add_on_result_sid: add_on_result_sid payload_sid: sid - resource_url: /2010-04-01None + resource_url: /2010-04-01/Accounts/{account_sid}/Recordings/{reference_sid}/AddOnResults/{add_on_result_sid}/Payloads/{payload_sid}/Data.json parent: /Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json pathType: list get: @@ -25810,26 +27500,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListRecordingAddOnResultPayloadResponse @@ -25838,6 +27562,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Payload") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Payload")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Payloads")' examples: readFull: value: @@ -26056,26 +27784,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListRecordingTranscriptionResponse @@ -26084,6 +27846,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Transcription") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Transcription")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcriptions")' examples: readFull: value: @@ -26376,26 +28142,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListShortCodeResponse @@ -26404,6 +28204,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.short_code' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ShortCode") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ShortCode")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "ShortCodes")' examples: readFull: value: @@ -26734,26 +28538,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipAuthCallsCredentialListMappingResponse @@ -26762,6 +28600,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsCredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsCredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' examples: readEmpty: value: @@ -27023,26 +28865,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipAuthCallsIpAccessControlListMappingResponse @@ -27051,6 +28927,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsIpAccessControlListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthCallsIpAccessControlListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' examples: readEmpty: value: @@ -27321,26 +29201,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipAuthRegistrationsCredentialListMappingResponse @@ -27349,6 +29263,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AuthRegistrationsCredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AuthRegistrationsCredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Contents")' examples: readEmpty: value: @@ -27547,26 +29465,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipCredentialResponse @@ -27575,6 +29527,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Credential") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Credential")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Credentials")' examples: readFull: value: @@ -27909,26 +29865,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipCredentialListResponse @@ -27937,6 +29927,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' + x-field-extra-annotation: '@JacksonXmlProperty(localName="CredentialList") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="CredentialList")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialLists")' examples: readFull: value: @@ -28302,26 +30296,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipCredentialListMappingResponse @@ -28330,6 +30358,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="CredentialListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="CredentialListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "CredentialListMappings")' examples: readFull: value: @@ -28541,26 +30573,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipDomainResponse @@ -28569,6 +30635,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Domain") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Domain")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Domains")' examples: readFull: value: @@ -29137,26 +31207,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipIpAccessControlListResponse @@ -29165,6 +31269,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlList") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlList")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlLists")' examples: readFull: value: @@ -29635,26 +31743,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipIpAccessControlListMappingResponse @@ -29663,6 +31805,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlListMapping") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAccessControlListMapping")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAccessControlListMappings")' examples: readFull: value: @@ -29761,26 +31907,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListSipIpAddressResponse @@ -29789,6 +31969,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' + x-field-extra-annotation: '@JacksonXmlProperty(localName="IpAddress") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="IpAddress")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "IpAddresses")' examples: readFull: value: @@ -31925,26 +34109,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListTranscriptionResponse @@ -31953,6 +34171,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.transcription' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Transcription") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Transcription")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "Transcriptions")' examples: readFull: value: @@ -32113,26 +34335,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordResponse @@ -32141,6 +34397,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Record") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Record")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -32287,26 +34547,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordAllTimeResponse @@ -32315,6 +34609,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' + x-field-extra-annotation: '@JacksonXmlProperty(localName="AllTime") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="AllTime")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -32461,26 +34759,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordDailyResponse @@ -32489,6 +34821,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Daily") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Daily")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -32635,26 +34971,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordLastMonthResponse @@ -32663,6 +35033,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' + x-field-extra-annotation: '@JacksonXmlProperty(localName="LastMonth") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="LastMonth")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -32809,26 +35183,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordMonthlyResponse @@ -32837,6 +35245,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Monthly") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Monthly")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -32983,26 +35395,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordThisMonthResponse @@ -33011,6 +35457,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' + x-field-extra-annotation: '@JacksonXmlProperty(localName="ThisMonth") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="ThisMonth")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -33157,26 +35607,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordTodayResponse @@ -33185,6 +35669,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Today") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Today")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -33331,26 +35819,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordYearlyResponse @@ -33359,6 +35881,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Yearly") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Yearly")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -33505,26 +36031,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageRecordYesterdayResponse @@ -33533,6 +36093,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Yesterday") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Yesterday")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageRecords")' examples: readFull: value: @@ -33979,26 +36543,60 @@ paths: - properties: end: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "end")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "end")' first_page_uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "firstpageuri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "firstpageuri")' next_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "nextpageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "nextpageuri")' page: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "page")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "page")' page_size: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "pagesize")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "pagesize")' previous_page_uri: format: uri nullable: true type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "previouspageuri") @JsonSerialize(nullsUsing + = XmlNullToEmptyStringSerializer.class)' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "previouspageuri")' start: type: integer + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "start")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "start")' uri: format: uri type: string + x-field-extra-annotation: '@JacksonXmlProperty(isAttribute = + true, localName = "uri")' + x-getter-extra-annotation: '@JacksonXmlProperty(isAttribute + = true, localName = "uri")' type: object - type: object title: ListUsageTriggerResponse @@ -34007,6 +36605,10 @@ paths: type: array items: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' + x-field-extra-annotation: '@JacksonXmlProperty(localName="Trigger") + @JacksonXmlElementWrapper(useWrapping = false)' + x-getter-extra-annotation: '@JacksonXmlProperty(localName="Trigger")' + x-class-extra-annotation: '@JacksonXmlRootElement(localName = "UsageTriggers")' examples: readFull: value: @@ -34301,6 +36903,7 @@ tags: - name: Api20100401Event - name: Api20100401Feedback - name: Api20100401FeedbackSummary +- name: Api20100401HealthCheck - name: Api20100401IncomingPhoneNumber - name: Api20100401IpAccessControlList - name: Api20100401IpAccessControlListMapping @@ -34345,3 +36948,5 @@ tags: - name: Api20100401Voip - name: Api20100401Yearly - name: Api20100401Yesterday +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_autopilot_v1.yaml b/spec/yaml/twilio_autopilot_v1.yaml deleted file mode 100644 index 5f0d3452..00000000 --- a/spec/yaml/twilio_autopilot_v1.yaml +++ /dev/null @@ -1,4519 +0,0 @@ -components: - securitySchemes: - accountSid_authToken: - scheme: basic - type: http - 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. -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.0.0 -openapi: 3.0.1 -paths: - /v1/Assistants/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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 - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - development_stage: in-development - needs_model_build: false - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - description: OK - security: - - accountSid_authToken: [] - operationId: FetchAssistant - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - development_stage: in-development - needs_model_build: false - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateAssistant - 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. - examples: - update: - value: - FriendlyName: so so friendly - UniqueName: so-so-unique - LogQueries: true - DevelopmentStage: in-development - CallbackUrl: https://example.com/callback_url - CallbackEvents: model_build_completed model_build_failed - StyleSheet: '{}' - Defaults: '{}' - delete: - description: '' - 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 - /v1/Assistants: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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 - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - assistants: [] - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 - key: assistants - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 - readFull: - value: - assistants: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - development_stage: in-development - needs_model_build: false - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 - key: assistants - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://autopilot.twilio.com/v1/Assistants?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListAssistant - post: - description: '' - tags: - - AutopilotV1Assistant - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.assistant' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - development_stage: in-development - needs_model_build: false - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - style_sheet: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - defaults: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - dialogues: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - webhooks: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - description: Created - security: - - accountSid_authToken: [] - operationId: CreateAssistant - 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. - examples: - create: - value: - FriendlyName: so so friendly - UniqueName: so-so-unique - LogQueries: true - CallbackUrl: https://example.com/callback_url - CallbackEvents: model_build_completed model_build_failed - StyleSheet: '{}' - Defaults: '{}' - /v1/Assistants/{AssistantSid}/Defaults: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - data - parent: /Assistants/{Sid} - className: defaults - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - data: {} - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDefaults - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Defaults - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDefaults - 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. - examples: - update: - value: - Defaults: '{}' - /v1/Assistants/{AssistantSid}/Dialogues/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - data - parent: /Assistants/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDialogue - /v1/Assistants/{AssistantSid}/Dialogues: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - data - parent: /Assistants/{Sid} - pathType: list - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - field_type - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type - description: OK - security: - - accountSid_authToken: [] - operationId: FetchField - 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 - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - field_type - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - fields: [] - meta: - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - key: fields - next_page_url: null - previous_page_url: null - page_size: 50 - readFull: - value: - fields: - - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type - meta: - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - key: fields - next_page_url: null - previous_page_url: null - page_size: 50 - description: OK - security: - - accountSid_authToken: [] - operationId: ListField - 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' - examples: - create: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type - description: Created - security: - - accountSid_authToken: [] - operationId: CreateField - 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 - examples: - create: - value: - UniqueName: unique_name - FieldType: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /v1/Assistants/{AssistantSid}/FieldTypes/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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} - pathType: instance - 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' - examples: - fetch: - value: - unique_name: unique_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - links: - field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchFieldType - 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' - examples: - update: - value: - unique_name: unique_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - links: - field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateFieldType - 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. - examples: - update: - value: - UniqueName: unique_name - FriendlyName: friendly_name - 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 - /v1/Assistants/{AssistantSid}/FieldTypes: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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} - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - previous_page_url: null - page: 0 - page_size: 50 - next_page_url: null - key: field_types - field_types: [] - readFull: - value: - meta: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - previous_page_url: null - page: 0 - page_size: 50 - next_page_url: null - key: field_types - field_types: - - unique_name: unique_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - links: - field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: ListFieldType - 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' - examples: - create: - value: - unique_name: unique_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - links: - field_values: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateFieldType - 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 - examples: - create: - value: - UniqueName: unique_name - FriendlyName: friendly_name - /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - value - - language - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' - date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: null - description: OK - security: - - accountSid_authToken: [] - operationId: FetchFieldValue - 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 - /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - value - - language - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - pathType: list - 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 - examples: - readEmpty: - value: language - readFull: - value: language - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListFieldValueResponse - properties: - field_values: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - field_values: [] - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 - page_size: 50 - previous_page_url: null - key: field_values - page: 0 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 - readFull: - value: - field_values: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' - date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 - page_size: 50 - previous_page_url: null - key: field_values - page: 0 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListFieldValue - 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' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' - date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - description: Created - security: - - accountSid_authToken: [] - operationId: CreateFieldValue - 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 - examples: - create: - value: - Value: value - Language: language - SynonymOf: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - /v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - status - - date_created - parent: /Assistants/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: enqueued - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: null - description: OK - security: - - accountSid_authToken: [] - operationId: FetchModelBuild - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: completed - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: 100 - error_code: null - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateModelBuild - 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. - examples: - update: - value: - UniqueName: unique_name - 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 - /v1/Assistants/{AssistantSid}/ModelBuilds: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - status - - date_created - parent: /Assistants/{Sid} - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - page: 0 - key: model_builds - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - next_page_url: null - previous_page_url: null - page_size: 50 - model_builds: [] - readFull: - value: - meta: - page: 0 - key: model_builds - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - next_page_url: null - previous_page_url: null - page_size: 50 - model_builds: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: failed - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: 23001 - description: OK - security: - - accountSid_authToken: [] - operationId: ListModelBuild - 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' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: enqueued - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: null - description: Created - security: - - accountSid_authToken: [] - operationId: CreateModelBuild - 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. - examples: - create: - value: - UniqueName: unique_name - StatusCallback: http://www.example.com - /v1/Assistants/{AssistantSid}/Queries/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - query - - status - - language - parent: /Assistants/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - language: language - date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query - date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: name - fields: - - name: name - value: value - type: type - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: voice - dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchQuery - 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' - examples: - update: - value: - language: language - date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query - date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: name - fields: - - name: name - value: value - type: type - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: sms - dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateQuery - 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`' - examples: - update: - value: - Status: status - SampleSid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - 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 - /v1/Assistants/{AssistantSid}/Queries: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - query - - status - - language - parent: /Assistants/{Sid} - pathType: list - 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 - examples: - readEmpty: - value: language - readFull: - value: language - - name: ModelBuild - in: query - description: The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) - to be queried. - schema: - type: string - examples: - readEmpty: - value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - readFull: - value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - name: Status - in: query - description: 'The status of the resources to read. Can be: `pending-review`, - `reviewed`, or `discarded`' - schema: - type: string - examples: - readEmpty: - value: status - readFull: - value: status - - name: DialogueSid - in: query - description: The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ - examples: - readEmpty: - value: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - readFull: - value: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - queries: [] - meta: - previous_page_url: null - next_page_url: null - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 - page: 0 - key: queries - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 - page_size: 50 - readFull: - value: - queries: - - language: language - date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query - date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: name - fields: - - name: name - value: value - type: type - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: null - dialogue_sid: UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - previous_page_url: null - next_page_url: null - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 - page: 0 - key: queries - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DialogueSid=UKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 - page_size: 50 - description: OK - security: - - accountSid_authToken: [] - operationId: ListQuery - 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' - examples: - create: - value: - language: language - date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query - date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: name - fields: - - name: name - value: value - type: type - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: voice - dialogue_sid: null - description: Created - security: - - accountSid_authToken: [] - operationId: CreateQuery - 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 - examples: - create: - value: - Language: language - Query: query - Tasks: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - ModelBuild: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /v1/Assistants/Restore: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - account_sid - - sid - - unique_name - - friendly_name - mountName: restore_assistant - pathType: list - post: - description: '' - tags: - - AutopilotV1RestoreAssistant - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/autopilot.v1.restore_assistant' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - unique_name: so-so-unique - friendly_name: so so friendly - needs_model_build: false - latest_model_build_sid: null - log_queries: true - development_stage: in-development - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateRestoreAssistant - 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 - examples: - update: - value: - Assistant: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - tagged_text - - language - - source_channel - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text - date_updated: '2015-07-30T20:00:00Z' - source_channel: null - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSample - 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' - examples: - update: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text - date_updated: '2015-07-30T20:00:00Z' - source_channel: alexa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateSample - 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.' - examples: - update: - value: - Language: language - TaggedText: tagged_text - 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 - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - tagged_text - - language - - source_channel - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: list - 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 - examples: - readEmpty: - value: language - readFull: - value: language - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListSampleResponse - properties: - samples: - type: array - items: - $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - samples: [] - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - previous_page_url: null - key: samples - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - page: 0 - page_size: 50 - readFull: - value: - samples: - - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text - date_updated: '2015-07-30T20:00:00Z' - source_channel: sms - meta: - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - previous_page_url: null - key: samples - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - page: 0 - page_size: 50 - description: OK - security: - - accountSid_authToken: [] - operationId: ListSample - 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' - examples: - create: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text - date_updated: '2015-07-30T20:00:00Z' - source_channel: alexa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSample - 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 - examples: - create: - value: - Language: language - TaggedText: tagged_text - SourceChannel: alexa - /v1/Assistants/{AssistantSid}/StyleSheet: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - data - parent: /Assistants/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - data: {} - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - description: OK - security: - - accountSid_authToken: [] - operationId: FetchStyleSheet - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateStyleSheet - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateStyleSheetRequest - properties: - StyleSheet: - description: The JSON string that describes the style sheet object. - examples: - update: - value: - StyleSheet: '{}' - /v1/Assistants/{AssistantSid}/Tasks/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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} - pathType: instance - 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' - examples: - fetch: - value: - unique_name: unique_name - links: - fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTask - 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' - examples: - update: - value: - unique_name: unique_name - links: - fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateTask - 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. - examples: - update: - value: - FriendlyName: friendly_name - UniqueName: unique_name - Actions: '{}' - ActionsUrl: https://example.com/actions_url - 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 - /v1/Assistants/{AssistantSid}/Tasks: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - friendly_name - 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} - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - key: tasks - page_size: 50 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 - previous_page_url: null - tasks: [] - readFull: - value: - meta: - key: tasks - page_size: 50 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 - previous_page_url: null - tasks: - - unique_name: unique_name - links: - fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: OK - security: - - accountSid_authToken: [] - operationId: ListTask - 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' - examples: - create: - value: - unique_name: unique_name - links: - fields: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: Created - security: - - accountSid_authToken: [] - operationId: CreateTask - 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 - examples: - create: - value: - FriendlyName: friendly_name - UniqueName: unique_name - Actions: '{}' - ActionsUrl: https://example.com/actions_url - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - data - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - mountName: task_actions - className: task_actions - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDdddddddddddddddddddddddddddddddd - data: {} - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTaskActions - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDdddddddddddddddddddddddddddddddd - data: {} - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateTaskActions - 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. - examples: - update: - value: - Actions: '{"actions":[{}]}' - /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - samples_count - - fields_count - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - className: task_statistics - pathType: instance - 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' - examples: - fetch: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - samples_count: 0 - fields_count: 0 - description: OK - security: - - accountSid_authToken: [] - operationId: FetchTaskStatistics - /v1/Assistants/{AssistantSid}/Webhooks/{Sid}: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - events - - wehbook_url - - webhook_method - parent: /Assistants/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - unique_name: unique_name - events: ondialogueend - webhook_url: https://example.com/url - webhook_method: POST - description: OK - security: - - accountSid_authToken: [] - operationId: FetchWebhook - 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' - examples: - update: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - unique_name: unique_name - events: ondialogueend - webhook_url: https://example.com/url - webhook_method: POST - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateWebhook - 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. - examples: - update: - value: - UniqueName: unique_name - Events: ondialogueend - WebhookUrl: https://example.com/url - WebhookMethod: POST - 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 - /v1/Assistants/{AssistantSid}/Webhooks: - servers: - - url: https://autopilot.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - sid - - unique_name - - events - - wehbook_url - - webhook_method - parent: /Assistants/{Sid} - pathType: list - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - key: webhooks - page_size: 50 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 - previous_page_url: null - webhooks: [] - readFull: - value: - meta: - key: webhooks - page_size: 50 - next_page_url: null - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 - page: 0 - first_page_url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=50&Page=0 - previous_page_url: null - webhooks: - - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - unique_name: unique_name - events: ondialogueend - webhook_url: https://example.com/url - webhook_method: POST - description: OK - security: - - accountSid_authToken: [] - operationId: ListWebhook - 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' - examples: - create: - value: - url: https://autopilot.twilio.com/v1/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - unique_name: unique_name - events: ondialogueend - webhook_url: https://example.com/url - webhook_method: POST - description: Created - security: - - accountSid_authToken: [] - operationId: CreateWebhook - 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 - examples: - create: - value: - UniqueName: unique_name - Events: ondialogueend - WebhookUrl: https://example.com/url - WebhookMethod: POST -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 diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 187f4c5e..3b2a134e 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -882,3 +882,5 @@ tags: - name: BulkexportsV1ExportConfiguration - name: BulkexportsV1ExportCustomJob - name: BulkexportsV1Job +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index 22bd6743..8940f1e2 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -34,12 +34,20 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true @@ -47,6 +55,10 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -69,6 +81,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -118,6 +134,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -194,6 +214,10 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -265,6 +289,10 @@ components: the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -328,6 +356,10 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 service_sid: type: string minLength: 34 @@ -373,10 +405,18 @@ components: nullable: true description: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 index: type: integer nullable: true @@ -421,6 +461,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -479,6 +523,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -626,10 +674,18 @@ components: If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -645,6 +701,10 @@ components: resource's User within the [Service](https://www.twilio.com/docs/api/chat/rest/services). This value is often a username or an email address. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 is_online: type: boolean nullable: true @@ -1738,6 +1798,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: @@ -2156,6 +2220,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -4529,3 +4597,5 @@ tags: - name: ChatV1Service - name: ChatV1User - name: ChatV1UserChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index 6d24d941..ea13ed05 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -47,6 +47,10 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -55,6 +59,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 credential_sid: type: string minLength: 34 @@ -124,17 +132,29 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -157,6 +177,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -283,6 +307,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_service' @@ -359,6 +387,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -430,6 +462,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -473,6 +509,10 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 member_enum_webhook_enabled_type: type: string enum: @@ -501,6 +541,10 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 service_sid: type: string minLength: 34 @@ -542,6 +586,10 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable. + x-twilio: + pii: + handling: standard + deleteSla: 30 was_edited: type: boolean nullable: true @@ -551,10 +599,18 @@ components: nullable: true description: The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author. The default value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 index: type: integer nullable: true @@ -572,6 +628,10 @@ components: the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -617,6 +677,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -674,6 +738,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -837,10 +905,18 @@ components: nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -857,6 +933,10 @@ components: This value is often a username or an email address, and is case-sensitive. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 is_online: type: boolean nullable: true @@ -953,6 +1033,10 @@ components: nullable: true description: The unique endpoint identifier for the User Binding. The format of the value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -961,6 +1045,10 @@ components: within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 user_sid: type: string minLength: 34 @@ -1160,6 +1248,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -2875,6 +2967,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: @@ -3353,6 +3449,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5986,3 +6086,5 @@ tags: - name: ChatV2UserBinding - name: ChatV2UserChannel - name: ChatV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index fa21af7e..3a6ffdd1 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -34,17 +34,29 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/channel_enum_channel_type' @@ -67,6 +79,10 @@ components: nullable: true description: The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 members_count: type: integer nullable: true @@ -215,3 +231,5 @@ servers: - url: https://chat.twilio.com tags: - name: ChatV3Channel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_content_sdk.yaml b/spec/yaml/twilio_content_sdk.yaml new file mode 100644 index 00000000..b3bf7e98 --- /dev/null +++ b/spec/yaml/twilio_content_sdk.yaml @@ -0,0 +1,1307 @@ +components: + securitySchemes: + accountSid_authToken: + scheme: basic + type: http + schemas: + listItems: + type: array + items: + $ref: '#/components/schemas/listItem' + listItem: + type: object + additionalProperties: false + properties: + id: + type: string + item: + type: string + description: + type: string + required: + - id + - item + callToActionActions: + type: array + items: + $ref: '#/components/schemas/callToActionAction' + callToActionActionType: + type: string + enum: + - URL + - PHONE_NUMBER + callToActionAction: + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/callToActionActionType' + title: + type: string + url: + type: string + phone: + type: string + id: + type: string + required: + - type + - title + quickReplyActions: + type: array + items: + $ref: '#/components/schemas/quickReplyAction' + quickReplyActionType: + type: string + enum: + - QUICK_REPLY + quickReplyAction: + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/quickReplyActionType' + title: + type: string + id: + type: string + required: + - type + - title + cardActions: + type: array + items: + $ref: '#/components/schemas/cardAction' + cardActionType: + type: string + enum: + - URL + - PHONE_NUMBER + - QUICK_REPLY + cardAction: + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/cardActionType' + title: + type: string + url: + type: string + phone: + type: string + id: + type: string + required: + - type + - title + authenticationActions: + type: array + items: + $ref: '#/components/schemas/authenticationAction' + authenticationActionType: + type: string + enum: + - COPY_CODE + authenticationAction: + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/authenticationActionType' + copy_code_text: + type: string + required: + - type + - copy_code_text + twilioText: + type: object + description: Type containing only plain text-based content + nullable: true + additionalProperties: false + properties: + body: + type: string + required: + - body + twilioMedia: + type: object + description: twilio/media is used to send file attachments, or to send long + text via MMS in the US and Canada. As such, the twilio/media type must contain + at least ONE of text or media content. + nullable: true + additionalProperties: false + properties: + body: + type: string + media: + type: array + items: + type: string + required: + - media + twilioLocation: + type: object + description: twilio/location type contains a location pin and an optional label, + which can be used to enhance delivery notifications or connect recipients + to physical experiences you offer. + nullable: true + additionalProperties: false + properties: + latitude: + type: number + longitude: + type: number + label: + type: string + required: + - latitude + - longitude + twilioListPicker: + type: object + description: twilio/list-picker includes a menu of up to 10 options, which offers + a simple way for users to make a selection. + nullable: true + additionalProperties: false + properties: + body: + type: string + button: + type: string + items: + $ref: '#/components/schemas/listItems' + required: + - body + - button + - items + twilioCallToAction: + type: object + description: twilio/call-to-action buttons let recipients tap to trigger actions + such as launching a website or making a phone call. + nullable: true + additionalProperties: false + properties: + body: + type: string + actions: + $ref: '#/components/schemas/callToActionActions' + twilioQuickReply: + type: object + description: twilio/quick-reply templates let recipients tap, rather than type, + to respond to the message. + nullable: true + additionalProperties: false + properties: + body: + type: string + actions: + $ref: '#/components/schemas/quickReplyActions' + required: + - body + - actions + twilioCard: + type: object + description: twilio/card is a structured template which can be used to send + a series of related information. It must include a title and at least one + additional field. + nullable: true + additionalProperties: false + properties: + title: + type: string + subtitle: + type: string + media: + type: array + items: + type: string + actions: + $ref: '#/components/schemas/cardActions' + required: + - title + whatsappCard: + type: object + description: whatsapp/card is a structured template which can be used to send + a series of related information. It must include a body and at least one additional + field. + nullable: true + additionalProperties: false + properties: + body: + type: string + footer: + type: string + media: + type: array + items: + type: string + header_text: + type: string + actions: + $ref: '#/components/schemas/cardActions' + required: + - body + whatsappAuthentication: + type: object + description: whatsApp/authentication templates let companies deliver WA approved + one-time-password button. + nullable: true + additionalProperties: false + properties: + add_security_recommendation: + type: boolean + code_expiration_minutes: + type: number + actions: + $ref: '#/components/schemas/authenticationActions' + required: + - actions + ContentApprovalRequest: + type: object + description: Content approval request body + required: + - name + - category + properties: + name: + description: Name of the template. + type: string + category: + description: A WhatsApp recognized template category. + type: string + ContentCreateRequest: + type: object + description: Content creation request body + properties: + friendly_name: + description: User defined name of the content + type: string + variables: + description: Key value pairs of variable name to value + type: object + additionalProperties: + type: string + language: + description: Language code for the content + type: string + types: + $ref: '#/components/schemas/types' + required: + - language + - types + types: + description: Content types + type: object + properties: + twilio/text: + $ref: '#/components/schemas/twilioText' + twilio/media: + $ref: '#/components/schemas/twilioMedia' + twilio/location: + $ref: '#/components/schemas/twilioLocation' + twilio/list-picker: + $ref: '#/components/schemas/twilioListPicker' + twilio/call-to-action: + $ref: '#/components/schemas/twilioCallToAction' + twilio/quick-reply: + $ref: '#/components/schemas/twilioQuickReply' + twilio/card: + $ref: '#/components/schemas/twilioCard' + whatsapp/card: + $ref: '#/components/schemas/whatsappCard' + whatsapp/authentication: + $ref: '#/components/schemas/whatsappAuthentication' + content.v1.content.approval_create: + type: object + properties: + name: + type: string + nullable: true + category: + type: string + nullable: true + content_type: + type: string + nullable: true + status: + type: string + nullable: true + rejection_reason: + type: string + nullable: true + allow_category_change: + type: boolean + nullable: true + content.v1.content.approval_fetch: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that that we created to identify the Content + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/usage/api/account) + that created Content resource. + whatsapp: + nullable: true + description: Contains the whatsapp approval information for the Content + resource, with fields such as approval status, rejection reason, and category, + amongst others. + url: + type: string + format: uri + nullable: true + description: The URL of the resource, relative to `https://content.twilio.com`. + content.v1.content: + type: object + properties: + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that that we created to identify the Content + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/usage/api/account) + that created Content resource. + friendly_name: + type: string + nullable: true + description: A string name used to describe the Content resource. Not visible + to the end recipient. + language: + type: string + nullable: true + description: Two-letter (ISO 639-1) language code (e.g., en) identifying + the language the Content resource is in. + variables: + nullable: true + description: 'Defines the default placeholder values for variables included + in the Content resource. e.g. {"1": "Customer_Name"}.' + types: + nullable: true + description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + (e.g. twilio/text) for this Content resource. + url: + type: string + format: uri + nullable: true + description: The URL of the resource, relative to `https://content.twilio.com`. + links: + type: object + format: uri-map + nullable: true + description: A list of links related to the Content resource, such as approval_fetch + and approval_create + content.v1.content_and_approvals: + type: object + properties: + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that that we created to identify the Content + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/usage/api/account) + that created Content resource. + friendly_name: + type: string + nullable: true + description: A string name used to describe the Content resource. Not visible + to the end recipient. + language: + type: string + nullable: true + description: Two-letter (ISO 639-1) language code (e.g., en) identifying + the language the Content resource is in. + variables: + nullable: true + description: 'Defines the default placeholder values for variables included + in the Content resource. e.g. {"1": "Customer_Name"}.' + types: + nullable: true + description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + (e.g. twilio/text) for this Content resource. + approval_requests: + nullable: true + description: The submitted information and approval request status of the + Content resource. + content.v1.legacy_content: + type: object + properties: + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was created specified + in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT that the resource was last updated + specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that that we created to identify the Content + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/usage/api/account) + that created Content resource. + friendly_name: + type: string + nullable: true + description: A string name used to describe the Content resource. Not visible + to the end recipient. + language: + type: string + nullable: true + description: Two-letter (ISO 639-1) language code (e.g., en) identifying + the language the Content resource is in. + variables: + nullable: true + description: 'Defines the default placeholder values for variables included + in the Content resource. e.g. {"1": "Customer_Name"}.' + types: + nullable: true + description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + (e.g. twilio/text) for this Content resource. + legacy_template_name: + type: string + nullable: true + description: The string name of the legacy content template associated with + this Content resource, unique across all template names for its account. Only + lowercase letters, numbers and underscores are allowed + legacy_body: + type: string + nullable: true + description: The string body field of the legacy content template associated + with this Content resource + url: + type: string + format: uri + nullable: true + description: The URL of the resource, relative to `https://content.twilio.com`. +info: + title: Twilio - Content + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.1.0 +openapi: 3.0.1 +paths: + /v1/Content/{Sid}/ApprovalRequests/whatsapp: + servers: + - url: https://content.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - sid + - account_sid + - whatsapp + parent: /Content/{Sid} + mountName: approval_create + pathType: list + post: + description: '' + tags: + - Contentv1ApprovalCreate + parameters: + - name: Sid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ContentApprovalRequest' + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/content.v1.content.approval_create' + examples: + createApproval: + value: + name: tree_fiddy + category: UTILITY + content_type: twilio/location + status: unsubmitted + rejection_reason: '' + allow_category_change: true + description: Created + security: + - accountSid_authToken: [] + operationId: CreateContentApprovalRequest + /v1/Content/{Sid}/ApprovalRequests: + servers: + - url: https://content.twilio.com + description: An Approval Fetch resource represents the approval status of a Content + resource. + x-twilio: + defaultOutputProperties: + - sid + - account_sid + - whatsapp + parent: /Content/{Sid} + mountName: approval_fetch + pathType: instance + get: + description: Fetch a Content resource's approval status by its unique Content + Sid + tags: + - Contentv1ApprovalFetch + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Content + resource whose approval information to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/content.v1.content.approval_fetch' + examples: + getApproval: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + whatsapp: + type: whatsapp + name: tree_fiddy + category: UTILITY + content_type: twilio/location + status: approved + rejection_reason: '' + allow_category_change: true + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + description: OK + security: + - accountSid_authToken: [] + operationId: FetchApproval + /v1/Content/{Sid}: + servers: + - url: https://content.twilio.com + description: A Content resource represents rich messaging content. + x-twilio: + defaultOutputProperties: + - date_created + - date_updated + - sid + - account_sid + - friendly_name + - language + - variables + - types + dependentProperties: + approval_create: + mapping: + content_sid: sid + resource_url: /v1/Content/{content_sid}/ApprovalRequests/whatsapp + approval_fetch: + mapping: + content_sid: sid + resource_url: /v1/Content/{content_sid}/ApprovalRequests + mountName: contents + pathType: instance + get: + description: Fetch a Content resource by its unique Content Sid + tags: + - Contentv1Content + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Content + resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/content.v1.content' + examples: + fetch: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + description: OK + security: + - accountSid_authToken: [] + operationId: FetchContent + delete: + description: Deletes a Content resource + tags: + - Contentv1Content + parameters: + - name: Sid + in: path + description: The Twilio-provided string that uniquely identifies the Content + resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HX[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteContent + /v1/Content: + servers: + - url: https://content.twilio.com + description: A Content resource represents rich messaging content. + x-twilio: + defaultOutputProperties: + - date_created + - date_updated + - sid + - account_sid + - friendly_name + - language + - variables + - types + dependentProperties: + approval_create: + mapping: + content_sid: sid + resource_url: /v1/Content/{content_sid}/ApprovalRequests/whatsapp + approval_fetch: + mapping: + content_sid: sid + resource_url: /v1/Content/{content_sid}/ApprovalRequests + mountName: contents + pathType: list + post: + description: Create a Content resource + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ContentCreateRequest' + tags: + - Contentv1Content + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/content.v1.content' + examples: + create: + value: + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: '' + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + description: Created + security: + - accountSid_authToken: [] + operationId: CreateContent + get: + description: Retrieve a list of Contents belonging to the account used to make + the request + tags: + - Contentv1Content + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListContentResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/content.v1.content' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + links: + approval_create: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp + approval_fetch: https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/Content?PageSize=20&Page=0 + next_page_url: null + key: contents + description: OK + security: + - accountSid_authToken: [] + operationId: ListContent + /v1/ContentAndApprovals: + servers: + - url: https://content.twilio.com + description: A Content resource represents rich messaging content and its respective + approval request status. + x-twilio: + defaultOutputProperties: + - date_created + - date_updated + - sid + - account_sid + - friendly_name + - language + - variables + - types + - approval_requests + className: content_and_approvals + pathType: list + get: + description: Retrieve a list of Contents with approval statuses belonging to + the account used to make the request + tags: + - Contentv1ContentAndApprovals + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListContentAndApprovalsResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/content.v1.content_and_approvals' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + previous_page_url: null + next_page_url: null + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=10&Page=0 + key: contents + readResults: + value: + contents: + - date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + approval_requests: + name: '' + category: '' + content_type: '' + status: unsubmitted + rejection_reason: '' + allow_category_change: true + - language: en + date_updated: '2023-01-13T23:33:46Z' + variables: + '1': name + '2': typedocument + friendly_name: Media Test + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX5fcd48a417c1cb59da349ad6d5da4607 + date_created: '2023-01-13T23:33:46Z' + types: + twilio/media: + body: '{{1}}, Congratulations {{2}}! For additional assistance, + please contact us at hello@twilio.com' + media: + - https://example.com/template + approval_requests: + category: TRANSACTIONAL + status: approved + rejection_reason: '' + name: Media Test + content_type: twilio/media + allow_category_change: false + - language: en + date_updated: '2023-01-18T02:46:35Z' + variables: + '1': name + '2': type_video + '3': small.mp4 + friendly_name: Video Highlights + account_sid: AC25c0d4b9093547216c460212e24e77ee + sid: HX15c711fcc6d9ea5268d7ab77938a20ff + date_created: '2023-01-18T02:46:35Z' + types: + twilio/media: + body: Hi there, {{1}}, we have received your request to + upload {{2}}, and should be uploaded shortly. + media: + - http://example.com/highlights/{{3}} + approval_requests: + category: TRANSACTIONAL + status: rejected + rejection_reason: 'INVALID_FORMAT. Facebook is not able to + create template with templateName=Video Highlights_hx15c711fcc6d9ea5268d7ab77938a20ff + due to the following error: Invalid parameter. More Details: + Message template ''components'' param is missing expected + field(s). component of type HEADER is missing expected field(s) + (example)' + name: Video Highlights + content_type: twilio/media + allow_category_change: true + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + url: https://content.twilio.com/v1/ContentAndApprovals?PageSize=20&Page=0 + previous_page_url: null + next_page_url: null + key: contents + description: OK + security: + - accountSid_authToken: [] + operationId: ListContentAndApprovals + /v1/LegacyContent: + servers: + - url: https://content.twilio.com + description: A Legacy Content resource represents legacy rich messaging content. + x-twilio: + defaultOutputProperties: + - date_created + - date_updated + - sid + - account_sid + - friendly_name + - language + - variables + - types + - legacy_template_name + - legacy_body + mountName: legacy_contents + pathType: list + get: + description: Retrieve a list of Legacy Contents belonging to the account used + to make the request + tags: + - Contentv1LegacyContent + parameters: + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListLegacyContentResponse + properties: + contents: + type: array + items: + $ref: '#/components/schemas/content.v1.legacy_content' + meta: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readEmpty: + value: + contents: [] + meta: + page: 0 + page_size: 10 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=10&Page=0 + next_page_url: null + key: contents + readResults: + value: + contents: + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Some content + language: en + variables: + name: foo + legacy_template_name: legacy_template_1 + legacy_body: a body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Anotha content + language: en + variables: + name: foo + legacy_template_name: legacy_template_2 + legacy_body: another body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + - sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Third content + language: en + variables: + name: foo + legacy_template_name: legacy_template_3 + legacy_body: a third body + types: + twilio/text: + body: Foo Bar Co is located at 39.7392, 104.9903 + twilio/location: + longitude: 104.9903 + latitude: 39.7392 + label: Foo Bar Co + url: https://content.twilio.com/v1/LegacyContent + date_created: '2015-07-30T19:00:00Z' + date_updated: '2015-07-30T19:00:00Z' + meta: + page: 0 + page_size: 20 + first_page_url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + previous_page_url: null + url: https://content.twilio.com/v1/LegacyContent?PageSize=20&Page=0 + next_page_url: null + key: contents + description: OK + security: + - accountSid_authToken: [] + operationId: ListLegacyContent +servers: +- url: https://content.twilio.com +tags: +- name: Contentv1ApprovalCreate +- name: Contentv1ApprovalFetch +- name: Contentv1Content +- name: Contentv1ContentAndApprovals +- name: Contentv1LegacyContent diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index b5e1f356..da30a48b 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -80,7 +80,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource. url: type: string @@ -140,7 +140,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource. approval_requests: nullable: true @@ -193,7 +193,7 @@ components: in the Content resource. e.g. {"1": "Customer_Name"}.' types: nullable: true - description: The [Content types](https://www.twilio.com/docs/content-api/content-types-overview) + description: The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource. legacy_template_name: type: string @@ -300,7 +300,7 @@ paths: approval_fetch: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/Content/{sid}/ApprovalRequests mountName: contents pathType: instance get: @@ -393,7 +393,7 @@ paths: approval_fetch: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/Content/{sid}/ApprovalRequests mountName: contents pathType: list get: @@ -884,3 +884,5 @@ tags: - name: ContentV1Content - name: ContentV1ContentAndApprovals - name: ContentV1LegacyContent +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 0c13fefc..9666b7da 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -79,6 +79,10 @@ components: nullable: true description: The unique address to be configured. The address can be a whatsapp address or phone number + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -221,18 +225,30 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 state: type: string $ref: '#/components/schemas/conversation_enum_state' @@ -315,10 +331,18 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 media: type: array items: {} @@ -328,12 +352,20 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 participant_sid: type: string minLength: 34 @@ -374,7 +406,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. conversation_message_enum_order_type: type: string @@ -504,17 +536,29 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 role_sid: type: string minLength: 34 @@ -645,6 +689,10 @@ components: nullable: true description: The human-readable name of this credential, limited to 64 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/credential_enum_push_type' @@ -718,11 +766,19 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -736,17 +792,29 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 conversation_date_created: type: string format: date-time @@ -815,6 +883,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/role_enum_role_type' @@ -873,6 +945,10 @@ components: nullable: true description: The human-readable name of this service, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -944,6 +1020,10 @@ components: nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. + x-twilio: + pii: + handling: standard + deleteSla: 30 identity: type: string nullable: true @@ -952,6 +1032,10 @@ components: within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 binding_type: type: string $ref: '#/components/schemas/service_binding_enum_binding_type' @@ -1070,18 +1154,30 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 state: type: string $ref: '#/components/schemas/service_conversation_enum_state' @@ -1170,10 +1266,18 @@ components: nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 media: type: array items: {} @@ -1183,12 +1287,20 @@ components: with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object''s file size in bytes. If the Message has no media, this value is `null`.' + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 participant_sid: type: string minLength: 34 @@ -1229,7 +1341,7 @@ components: maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. service_conversation_message_enum_order_type: type: string @@ -1376,17 +1488,29 @@ 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 @@ -1571,11 +1695,19 @@ components: as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_sid: type: string minLength: 34 @@ -1589,17 +1721,29 @@ components: nullable: true description: An application-defined string that uniquely identifies the Conversation resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_attributes: type: string nullable: true description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 conversation_date_created: type: string format: date-time @@ -1668,6 +1812,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 type: type: string $ref: '#/components/schemas/service_role_enum_role_type' @@ -1743,15 +1891,27 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 is_online: type: boolean nullable: true @@ -1853,6 +2013,10 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/service_user_conversation_enum_state' @@ -1868,6 +2032,10 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time @@ -1896,6 +2064,10 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -2018,15 +2190,27 @@ components: description: The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 is_online: type: boolean nullable: true @@ -2128,6 +2312,10 @@ components: nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. + x-twilio: + pii: + handling: standard + deleteSla: 30 conversation_state: type: string $ref: '#/components/schemas/user_conversation_enum_state' @@ -2143,6 +2331,10 @@ components: description: An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set "{}" will be returned. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 date_created: type: string format: date-time @@ -2171,6 +2363,10 @@ components: description: An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL. + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -3481,7 +3677,7 @@ paths: mapping: conversation_sid: conversation_sid message_sid: sid - resource_url: /v1None + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} pathType: list post: @@ -3683,7 +3879,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. @@ -3953,7 +4149,7 @@ paths: mapping: conversation_sid: conversation_sid message_sid: sid - resource_url: /v1None + resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} pathType: instance post: @@ -6154,7 +6350,7 @@ paths: configuration: mapping: chat_service_sid: sid - resource_url: /v1None + resource_url: /v1/Services/{chat_service_sid}/Configuration participant_conversations: mapping: chat_service_sid: sid @@ -6324,7 +6520,7 @@ paths: configuration: mapping: chat_service_sid: sid - resource_url: /v1None + resource_url: /v1/Services/{chat_service_sid}/Configuration participant_conversations: mapping: chat_service_sid: sid @@ -6531,6 +6727,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7323,7 +7523,7 @@ paths: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid - resource_url: /v1None + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: list post: @@ -7540,7 +7740,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ - description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content-api) + description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages. **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored. @@ -7827,7 +8027,7 @@ paths: chat_service_sid: chat_service_sid conversation_sid: conversation_sid message_sid: sid - resource_url: /v1None + resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: instance post: @@ -11651,3 +11851,5 @@ tags: - name: ConversationsV1User - name: ConversationsV1UserConversation - name: ConversationsV1Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index b65fe306..b094d2fb 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -191,7 +191,7 @@ components: schema_version: type: integer nullable: true - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. subscription_sid: type: string minLength: 34 @@ -1257,7 +1257,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 @@ -1372,7 +1372,7 @@ paths: - accountSid_authToken: [] operationId: ListSubscribedEvent post: - description: Create a new Subscribed Event type for the subscription + description: Add an event type to a Subscription. tags: - EventsV1SubscribedEvent parameters: @@ -1415,7 +1415,7 @@ paths: description: Type of event being subscribed to. SchemaVersion: type: integer - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. required: - Type examples: @@ -1426,7 +1426,7 @@ paths: /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 @@ -1520,13 +1520,13 @@ paths: properties: SchemaVersion: type: integer - description: The schema version that the subscription should use. + description: The schema version that the Subscription should use. examples: update: value: SchemaVersion: 2 delete: - description: Remove an event type from a subscription. + description: Remove an event type from a Subscription. tags: - EventsV1SubscribedEvent parameters: @@ -1922,3 +1922,5 @@ tags: - name: EventsV1SinkValidate - name: EventsV1SubscribedEvent - name: EventsV1Subscription +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 9dd92655..b2ead4f2 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -166,6 +166,13 @@ components: pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex service instance. + flex_instance_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex instance. ui_language: type: string nullable: true @@ -289,6 +296,9 @@ 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: @@ -330,6 +340,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 chat_service_sid: type: string minLength: 34 @@ -518,6 +532,106 @@ components: type: string format: uri nullable: true + flex.v1.insights_conversational_ai: + type: object + properties: + instance_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + nullable: true + description: Sid of Flex Service Instance + report_id: + type: string + nullable: true + description: The type of report required to fetch.Like gauge,channel-metrics,queue-metrics + granularity: + type: string + $ref: '#/components/schemas/insights_conversational_ai_enum_granularity' + nullable: true + description: The time period for which report is needed + period_start: + type: string + format: date-time + nullable: true + description: The start date from which report data is included + period_end: + type: string + format: date-time + nullable: true + description: The end date till report data is included + updated: + type: string + format: date-time + nullable: true + description: Updated time of the report + total_pages: + type: integer + nullable: true + description: Represents total number of pages fetched report has + page: + type: integer + nullable: true + description: Page offset required for pagination + rows: + type: array + items: {} + nullable: true + description: 'List of report breakdown ' + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + insights_conversational_ai_enum_granularity: + type: string + enum: + - days + - weeks + - months + - quarters + - years + flex.v1.insights_conversational_ai_report_insights: + type: object + properties: + instance_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + nullable: true + description: The Instance SID of the instance for which report insights + is fetched + report_id: + type: string + nullable: true + description: The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics + period_start: + type: string + format: date-time + nullable: true + description: The start date from which report insights data is included + period_end: + type: string + format: date-time + nullable: true + description: The end date till report insights data is included + updated: + type: string + format: date-time + nullable: true + description: Updated time of the report insights + insights: + type: array + items: {} + nullable: true + description: List of report insights breakdown + url: + type: string + format: uri + nullable: true + description: The URL of this resource flex.v1.insights_conversations: type: object properties: @@ -880,10 +994,10 @@ components: $ref: '#/components/schemas/interaction_channel_enum_type' nullable: true description: "The Interaction Channel's type. Can be: `sms`, `email`, `chat`,\ - \ `whatsapp`, `web`. \n **Note:** These can be different from the task\ - \ channel type specified in the Routing attributes. Task channel type\ - \ corresponds to channel capacity while this channel type is the actual\ - \ media type" + \ `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be\ + \ different from the task channel type specified in the Routing attributes.\ + \ Task channel type corresponds to channel capacity while this channel\ + \ type is the actual media type" status: type: string $ref: '#/components/schemas/interaction_channel_enum_channel_status' @@ -1029,6 +1143,38 @@ 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 + transfer_enum_transfer_status: + type: string + enum: + - ACTIVE + - FAILED + - COMPLETED + transfer_enum_transfer_type: + type: string + enum: + - WARM + - COLD + - EXTERNAL flex.v1.web_channel: type: object properties: @@ -1428,6 +1574,7 @@ paths: messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ui_language: en ui_attributes: {} ui_dependencies: {} @@ -1547,6 +1694,9 @@ paths: dateUpdated: '2023-08-16T12:22:06.787Z' citrix_voice_vdi: enabled: false + offline_config: + presence: true + presence_ttl: 30 description: OK security: - accountSid_authToken: [] @@ -1609,6 +1759,7 @@ paths: messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + flex_instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ui_language: en ui_attributes: {} ui_dependencies: {} @@ -1712,6 +1863,9 @@ paths: dateUpdated: '2023-08-16T12:22:06.787Z' citrix_voice_vdi: enabled: false + offline_config: + presence: true + presence_ttl: 30 description: OK security: - accountSid_authToken: [] @@ -1738,6 +1892,10 @@ 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 @@ -2816,6 +2974,178 @@ paths: security: - accountSid_authToken: [] operationId: ListInsightsAssessmentsComment + /v1/Insights/Instances/{InstanceSid}/AI/Reports: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - report_id + mountName: insights_conversational_ai + pathType: instance + get: + description: Fetch Account Based Conversational AI Reports + tags: + - FlexV1InsightsConversationalAi + parameters: + - name: InstanceSid + in: path + description: Sid of Flex Service Instance + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + required: true + - name: MaxRows + in: query + description: Maximum number of rows to return + schema: + type: integer + examples: + readReports: + value: 10 + - name: ReportId + in: query + description: The type of report required to fetch.Like gauge,channel-metrics,queue-metrics + schema: + type: string + examples: + readReports: + value: gauge + - name: Granularity + in: query + description: The time period for which report is needed + schema: + type: string + $ref: '#/components/schemas/insights_conversational_ai_enum_granularity' + examples: + readReports: + value: days + - name: IncludeDate + in: query + description: A reference date that should be included in the returned period + schema: + type: string + format: date-time + examples: + readReports: + value: '2015-07-30T20:00:00Z' + - name: Page + in: query + description: Page offset required for pagination + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_conversational_ai' + examples: + readReports: + value: + instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + report_id: gauge + granularity: days + period_start: '2015-07-30T20:00:00Z' + period_end: '2015-07-30T20:00:00Z' + updated: '2015-07-30T20:00:00Z' + total_pages: 1 + page: 1 + rows: + - {} + url: https://flex-api.twilio.com/v1/Insights/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AI/Reports + description: OK + security: + - accountSid_authToken: [] + operationId: FetchInsightsConversationalAi + /v1/Insights/Instances/{InstanceSid}/AI/ReportInsights: + servers: + - url: https://flex-api.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - report_id + mountName: insights_conversational_ai_report_insights + className: insights_conversational_ai_report_insights + pathType: instance + get: + description: Fetch Instance Based Conversational AI Report Insights + tags: + - FlexV1InsightsConversationalAiReportInsights + parameters: + - name: InstanceSid + in: path + description: The Instance SID of the instance for which report insights will + be fetched + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^GO[0-9a-fA-F]{32}$ + required: true + - name: MaxRows + in: query + description: Maximum number of rows to return + schema: + type: integer + examples: + readReportinsights: + value: 10 + - name: ReportId + in: query + description: The type of report insights required to fetch.Like gauge,channel-metrics,queue-metrics + schema: + type: string + examples: + readReportinsights: + value: gauges + - name: Granularity + in: query + description: The time period for which report insights is needed + schema: + type: string + examples: + readReportinsights: + value: days + - name: IncludeDate + in: query + description: A reference date that should be included in the returned period + schema: + type: string + format: date-time + examples: + readReportinsights: + value: '2015-07-30T20:00:00Z' + - name: Page + in: query + description: Page offset required for pagination + schema: + type: integer + examples: + readReportinsights: + value: 1 + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.insights_conversational_ai_report_insights' + examples: + readReportinsights: + value: + instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + report_id: gauges + period_start: '2015-07-30T20:00:00Z' + period_end: '2015-07-30T20:00:00Z' + updated: '2015-07-30T20:00:00Z' + insights: [] + url: https://flex-api.twilio.com/v1/Insights/Instances/GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AI/ReportInsights + description: OK + security: + - accountSid_authToken: [] + operationId: FetchInsightsConversationalAiReportInsights /v1/Insights/Conversations: servers: - url: https://flex-api.twilio.com @@ -5410,6 +5740,34 @@ paths: updateStatusClosed: value: Status: closed + /v1/account/provision/status: + servers: + - url: https://flex-api.twilio.com + description: Status for email provisioning + x-twilio: + defaultOutputProperties: + - status + mountName: provisioning_status + pathType: instance + get: + description: '' + tags: + - FlexV1ProvisioningStatus + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.provisioning_status' + examples: + fetch: + value: + status: active + url: https://flex-api.twilio.com/v1/account/provision/status + description: OK + security: + - accountSid_authToken: [] + operationId: FetchProvisioningStatus /v1/WebChannels: servers: - url: https://flex-api.twilio.com @@ -5701,6 +6059,8 @@ tags: - name: FlexV1ConfiguredPlugin - name: FlexV1FlexFlow - name: FlexV1InsightsAssessmentsComment +- name: FlexV1InsightsConversationalAi +- name: FlexV1InsightsConversationalAiReportInsights - name: FlexV1InsightsConversations - name: FlexV1InsightsQuestionnaires - name: FlexV1InsightsQuestionnairesCategory @@ -5717,6 +6077,7 @@ tags: - name: FlexV1InteractionContext - name: FlexV1InteractionContextLookup - name: FlexV1InteractionContextLookupSid +- name: FlexV1InteractionContextUpdate - name: FlexV1LibraryPlugin - name: FlexV1LibraryPluginDetail - name: FlexV1LibraryPluginVariable @@ -5725,6 +6086,10 @@ tags: - name: FlexV1PluginConfiguration - name: FlexV1PluginRelease - name: FlexV1PluginVersion +- name: FlexV1ProvisioningStatus - name: FlexV1PublicConfiguration +- name: FlexV1Transfer - name: FlexV1VirtualAgentData - name: FlexV1WebChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index 21a7bf4a..7ed6f34c 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -120,3 +120,7 @@ tags: - name: FlexV2ConductorFlow - name: FlexV2User - name: FlexV2WebChannels +- name: FlexV2WebchatInitToken +- name: FlexV2WebchatRefreshToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index 6e309081..e1a6688d 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -20,10 +20,18 @@ components: description: The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the User. + x-twilio: + pii: + handling: standard + deleteSla: 30 avatar: type: string nullable: true @@ -170,3 +178,5 @@ servers: - url: https://frontline-api.twilio.com tags: - name: FrontlineV1User +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 8ce59ceb..5a3a5bb3 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -96,7 +96,6 @@ components: type: string format: uri nullable: true - description: The URL of this resource. annotation_enum_answered_by: type: string enum: @@ -215,9 +214,17 @@ 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 @@ -332,6 +339,10 @@ components: type: string nullable: true description: Custom label for the conference resource, up to 64 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 create_time: type: string format: date-time @@ -499,6 +510,10 @@ components: type: string nullable: true description: The user-specified label of this participant. + x-twilio: + pii: + handling: standard + deleteSla: 30 conference_sid: type: string minLength: 34 @@ -530,10 +545,18 @@ components: type: string nullable: true description: Caller ID of the calling party. + x-twilio: + pii: + handling: standard + deleteSla: 30 to: type: string nullable: true description: Called party. + x-twilio: + pii: + handling: standard + deleteSla: 30 call_status: type: string $ref: '#/components/schemas/conference_participant_enum_call_status' @@ -889,9 +912,17 @@ 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 @@ -1581,11 +1612,11 @@ paths: summary: mapping: call_sid: sid - resource_url: /v1None + resource_url: /v1/Voice/{call_sid}/Summary annotation: mapping: call_sid: sid - resource_url: /v1None + resource_url: /v1/Voice/{call_sid}/Annotation mountName: calls pathType: instance get: @@ -1651,12 +1682,20 @@ 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. @@ -2835,6 +2874,10 @@ paths: description: Custom label for the conference resource, up to 64 characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readWithFriendlynameStartfailure: value: outboundConfCallTransferThrice_1 @@ -3390,6 +3433,10 @@ paths: description: User-specified label for a participant. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readWithLabel: value: client @@ -4517,3 +4564,5 @@ tags: - name: InsightsV1Participant - name: InsightsV1Room - name: InsightsV1Setting +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 54d23cbd..a405b948 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -101,6 +101,10 @@ components: nullable: true description: List of text extraction results. This might be available on classify-extract model outputs. + text_generation_results: + nullable: true + description: Output of a text generation operator for example Conversation + Sumamary. transcript_sid: type: string minLength: 34 @@ -146,6 +150,10 @@ components: type: string nullable: true description: Transcript text. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 sid: type: string minLength: 34 @@ -186,9 +194,12 @@ components: data_logging: type: boolean nullable: true - description: Data logging allows Twilio to improve the quality of the speech - recognition through using customer data to refine its speech recognition - models. + description: 'Data logging allows Twilio to improve the quality of the speech + recognition & language understanding services through using customer data + to refine, fine tune and evaluate machine learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' date_created: type: string format: date-time @@ -290,9 +301,12 @@ components: data_logging: type: boolean nullable: true - description: Data logging allows Twilio to improve the quality of the speech - recognition through using customer data to refine its speech recognition - models. + description: 'Data logging allows Twilio to improve the quality of the speech + recognition & language understanding services through using customer data + to refine, fine tune and evaluate machine learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' language_code: type: string nullable: true @@ -526,6 +540,7 @@ paths: predicted_probability: '0.05' label_probabilities: {} extract_results: {} + text_generation_results: {} transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: @@ -604,6 +619,7 @@ paths: predicted_probability: '0.05' label_probabilities: {} extract_results: {} + text_generation_results: {} transcript_sid: GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK @@ -806,9 +822,13 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: Data logging allows Twilio to improve the quality of - the speech recognition through using customer data to refine its - speech recognition models. + description: 'Data logging allows Twilio to improve the quality + of the speech recognition & language understanding services through + using customer data to refine, fine tune and evaluate machine + learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to @@ -1069,9 +1089,13 @@ paths: transcribe all recordings made on the account. DataLogging: type: boolean - description: Data logging allows Twilio to improve the quality of - the speech recognition through using customer data to refine its - speech recognition models. + description: 'Data logging allows Twilio to improve the quality + of the speech recognition & language understanding services through + using customer data to refine, fine tune and evaluate machine + learning models. + + Note: Data logging cannot be activated via API, only via www.twilio.com, + as it requires additional consent.' FriendlyName: type: string description: A human readable description of this resource, up to @@ -1126,7 +1150,7 @@ paths: media: mapping: sid: sid - resource_url: /v2None + resource_url: /v2/Transcripts/{sid}/Media operator_results: mapping: transcript_sid: sid @@ -1441,7 +1465,7 @@ paths: media: mapping: sid: sid - resource_url: /v2None + resource_url: /v2/Transcripts/{sid}/Media operator_results: mapping: transcript_sid: sid @@ -1520,3 +1544,5 @@ tags: - name: IntelligenceV2Sentence - name: IntelligenceV2Service - name: IntelligenceV2Transcript +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 4305992f..1d0f1c37 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -3995,3 +3995,5 @@ tags: - name: IpMessagingV1Service - name: IpMessagingV1User - name: IpMessagingV1UserChannel +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 68189389..40dfd8d7 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -5306,3 +5306,5 @@ tags: - name: IpMessagingV2UserBinding - name: IpMessagingV2UserChannel - name: IpMessagingV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_lookups_bulk.yaml b/spec/yaml/twilio_lookups_bulk.yaml deleted file mode 100644 index 5ce8ea81..00000000 --- a/spec/yaml/twilio_lookups_bulk.yaml +++ /dev/null @@ -1,336 +0,0 @@ -openapi: 3.0.3 -info: - title: Lookup - termsOfService: https://www.twilio.com/legal/tos - version: 1.0.0-alpha.1 - description: 'Lookup APIs for individual, bulk and job based requests - - - Discussion topics: - - - API version to use - - - Using or not lookup in the path or just as lookups subdomain' - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html -servers: -- url: https://lookups.twilio.com -paths: - /v2/batch/query: {} -components: - schemas: - LookupRequest: - title: Lookup request - type: object - properties: - phone_number: - type: string - fields: - type: array - items: - type: string - enum: - - caller_name - - sim_swap - - call_forwarding - - live_activity - - line_type_intelligence - - identity_match - - reassigned_number - - sms_pumping_risk - - disposable_phone_number_risk - country_code: - type: string - identity_match: - $ref: '#/components/schemas/IdentityMatchParameters' - reassigned_number: - $ref: '#/components/schemas/ReassignedNumberRequest' - required: - - phone_number - description: '' - LookupRequestWithCorId: - title: LookupRequestWithCorId - allOf: - - $ref: '#/components/schemas/LookupRequest' - type: object - properties: - correlation_id: - type: string - description: Unique identifier used to match request with response - LookupResponse: - title: LookupResponse - type: object - properties: - calling_country_code: - type: string - country_code: - type: string - phone_number: - type: string - national_format: - type: string - valid: - type: boolean - validation_errors: - type: array - items: - type: string - caller_name: - $ref: '#/components/schemas/CallerName' - sim_swap: - $ref: '#/components/schemas/SimSwap' - call_forwarding: - $ref: '#/components/schemas/CallForwarding' - live_activity: - $ref: '#/components/schemas/LiveActivity' - line_type_intelligence: - $ref: '#/components/schemas/LineTypeIntelligence' - identity_match: - $ref: '#/components/schemas/IdentityMatch' - reassigned_number: - $ref: '#/components/schemas/ReassignedNumberResponse' - sms_pumping_risk: - $ref: '#/components/schemas/SmsPumpingRisk' - disposable_phone_number_risk: - $ref: '#/components/schemas/DisposablePhoneNumberRisk' - LookupResponseWithCorId: - allOf: - - $ref: '#/components/schemas/LookupResponse' - type: object - properties: - correlation_id: - type: string - description: Unique identifier used to match request with response - twilio_error_code: - type: integer - description: Twilio error conde in case that the request to downstream fails - CallerName: - title: CallerName - type: object - properties: - caller_name: - type: string - caller_type: - type: string - error_code: - type: integer - SimSwap: - title: SimSwap - allOf: - - $ref: '#/components/schemas/ATOCarrier' - properties: - last_sim_swap: - $ref: '#/components/schemas/LastSimSwap' - error_code: - type: integer - type: object - LastSimSwap: - title: SimSwap - properties: - last_sim_swap_date: - type: string - format: date-time - swapped_period: - type: string - swapped_in_period: - type: boolean - CallForwarding: - title: CallForwarding - type: object - allOf: - - $ref: '#/components/schemas/ATOCarrier' - properties: - call_forwarding_enabled: - type: boolean - error_code: - type: integer - ATOCarrier: - title: ATOCarrier - type: object - properties: - carrier_name: - type: string - mobile_country_code: - type: string - mobile_network_code: - type: string - LiveActivity: - title: LiveActivity - type: object - properties: - connectivity: - type: string - original_carrier: - $ref: '#/components/schemas/LiveActivityCarrier' - ported: - type: string - ported_carrier: - $ref: '#/components/schemas/LiveActivityCarrier' - roaming: - type: string - roaming_carrier: - $ref: '#/components/schemas/LiveActivityCarrier' - error_code: - type: integer - LiveActivityCarrier: - title: LiveActivityCarrier - allOf: - - $ref: '#/components/schemas/Carrier' - properties: - name: - type: string - country: - type: string - type: object - LineTypeIntelligence: - title: Packages/LineTypeIntelligence - type: object - allOf: - - $ref: '#/components/schemas/ATOCarrier' - properties: - type: - type: string - error_code: - type: integer - Carrier: - title: Carrier - type: object - properties: - mobile_country_code: - type: string - mobile_network_code: - type: string - IdentityMatch: - title: IdentityMatch - type: object - properties: - first_name_match: - type: string - last_name_match: - type: string - address_line_match: - type: string - city_match: - type: string - state_match: - type: string - postal_code_match: - type: string - country_code_match: - type: string - national_id_match: - type: string - date_of_birth_match: - type: string - summary_score: - type: integer - error_code: - type: integer - error_message: - type: string - IdentityMatchParameters: - title: IdentityMatchParameters - type: object - properties: - first_name: - type: string - last_name: - type: string - address_line1: - type: string - address_line2: - type: string - city: - type: string - state: - type: string - postal_code: - type: string - address_country_code: - type: string - national_id: - type: string - date_of_birth: - type: string - ReassignedNumberRequest: - title: ReassignedNumberRequest - type: object - properties: - last_verified_date: - type: string - maxLength: 8 - ReassignedNumberResponse: - title: ReassignedNumberResponse - type: object - properties: - last_verified_date: - type: string - is_number_reassigned: - type: string - error_code: - type: string - SmsPumpingRiskCarrier: - title: SmsPumpingRiskCarrier - allOf: - - $ref: '#/components/schemas/Carrier' - properties: - name: - type: string - carrier_risk_score: - type: integer - carrier_risk_category: - type: string - type: object - SmsPumpingRisk: - title: SmsPumpingRisk - type: object - properties: - carrier: - $ref: '#/components/schemas/SmsPumpingRiskCarrier' - number_blocked: - type: boolean - number_blocked_date: - type: string - format: date-time - number_blocked_last_3_months: - type: boolean - sms_pumping_risk_score: - type: integer - error_code: - type: integer - DisposablePhoneNumberRiskCarrier: - title: DisposablePhoneNumberRiskCarrier - allOf: - - $ref: '#/components/schemas/Carrier' - properties: - name: - type: string - carrier_risk_score: - type: integer - carrier_risk_category: - type: string - line_type: - type: string - type: object - DisposablePhoneNumberRisk: - title: DisposablePhoneNumberRisk - type: object - properties: - carrier: - $ref: '#/components/schemas/DisposablePhoneNumberRiskCarrier' - disposable_phone_risk_category: - type: string - disposable_phone_risk_score: - type: integer - velocity_risk_category: - type: string - velocity_risk_score: - type: integer - error_code: - type: integer - requestBodies: {} diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 0ca6ca79..c97e7213 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -11,11 +11,19 @@ components: nullable: true description: The name of the phone number's owner. If `null`, that information was not available. + x-twilio: + pii: + handling: standard + deleteSla: 30 country_code: type: string nullable: true description: The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) for the phone number. + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -23,10 +31,18 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 national_format: type: string nullable: true description: The phone number, in national format. + x-twilio: + pii: + handling: standard + deleteSla: 30 carrier: nullable: true description: The telecom company that provides the phone number. @@ -35,6 +51,10 @@ components: description: A JSON string with the results of the Add-ons you specified in the `add_ons` parameters. For the format of the object, see [Using Add-ons](https://www.twilio.com/docs/add-ons). + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -69,6 +89,7 @@ paths: - caller_name - country_code - carrier + - url pathType: instance get: description: '' @@ -83,6 +104,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: CountryCode in: query @@ -91,6 +116,10 @@ paths: phone number is provided in a national format. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: fetchCarrier: value: country_code @@ -151,6 +180,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: fetchAddonsWhitepagesPro: value: @@ -372,3 +405,5 @@ servers: - url: https://lookups.twilio.com tags: - name: LookupsV1PhoneNumber +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index bfc6c7df..748f79f8 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -16,6 +16,10 @@ components: type: string nullable: true description: The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). + x-twilio: + pii: + handling: standard + deleteSla: 30 phone_number: type: string format: phone-number @@ -23,10 +27,18 @@ components: description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. + x-twilio: + pii: + handling: standard + deleteSla: 30 national_format: type: string nullable: true description: The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers). + x-twilio: + pii: + handling: standard + deleteSla: 30 valid: type: boolean nullable: true @@ -44,6 +56,10 @@ components: caller_name: nullable: true description: An object that contains caller name information based on [CNAM](https://support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID). + x-twilio: + pii: + handling: standard + deleteSla: 30 sim_swap: nullable: true description: An object that contains information on the last date the subscriber @@ -139,6 +155,10 @@ paths: country code is +1 (North America). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Fields in: query @@ -186,6 +206,10 @@ 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)\ @@ -266,6 +290,10 @@ paths: \ parameter is only used (optionally) for identity_match package requests." schema: type: string + x-twilio: + pii: + handling: sensitive + deleteSla: 30 examples: fetchIdentityMatch: value: YZ3456883 @@ -275,6 +303,10 @@ paths: \ is only used (optionally) for identity_match package requests." schema: type: string + x-twilio: + pii: + handling: sensitive + deleteSla: 30 examples: fetchIdentityMatch: value: '19901214' @@ -447,10 +479,7 @@ paths: caller_name: null sim_swap: null call_forwarding: - call_forwarding_status: 'true' - carrier_name: Vodafone UK - mobile_country_code: '276' - mobile_network_code: '02' + call_forwarding_status: true error_code: null live_activity: null line_type_intelligence: null @@ -478,10 +507,7 @@ paths: mobile_network_code: '02' error_code: null call_forwarding: - call_forwarding_status: 'true' - carrier_name: Vodafone UK - mobile_country_code: '276' - mobile_network_code: '02' + call_forwarding_status: true error_code: null live_activity: null line_type_intelligence: null @@ -650,12 +676,7 @@ paths: identity_match: null reassigned_number: null sms_pumping_risk: - carrier: - name: Twilio Carrier - mobile_country_code: '214' - mobile_network_code: '07' - carrier_risk_score: 69 - carrier_risk_category: moderate + carrier_risk_category: moderate number_blocked: false number_blocked_date: null number_blocked_last_3_months: null @@ -764,3 +785,5 @@ servers: - url: https://lookups.twilio.com tags: - name: LookupsV2PhoneNumber +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index b9403236..319296f1 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -40,6 +40,10 @@ 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 @@ -804,11 +808,11 @@ paths: timed_metadata: mapping: media_recording_sid: sid - resource_url: /v1None + resource_url: /v1/MediaRecordings/{media_recording_sid}/TimedMetadata media: mapping: media_recording_sid: sid - resource_url: /v1None + resource_url: /v1/MediaRecordings/{media_recording_sid}/Media mountName: media_recording pathType: instance delete: @@ -888,11 +892,11 @@ paths: timed_metadata: mapping: media_recording_sid: sid - resource_url: /v1None + resource_url: /v1/MediaRecordings/{media_recording_sid}/TimedMetadata media: mapping: media_recording_sid: sid - resource_url: /v1None + resource_url: /v1/MediaRecordings/{media_recording_sid}/Media mountName: media_recording pathType: list get: @@ -1061,15 +1065,15 @@ paths: timed_metadata: mapping: player_streamer_sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata playback_grant: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{sid}/PlaybackGrant recording_playback_grant: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{sid}/RecordingPlaybackGrant mountName: player_streamer pathType: instance get: @@ -1185,15 +1189,15 @@ paths: timed_metadata: mapping: player_streamer_sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{player_streamer_sid}/TimedMetadata playback_grant: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{sid}/PlaybackGrant recording_playback_grant: mapping: sid: sid - resource_url: /v1None + resource_url: /v1/PlayerStreamers/{sid}/RecordingPlaybackGrant mountName: player_streamer pathType: list post: @@ -1535,3 +1539,5 @@ tags: - name: MediaV1Transcription - name: MediaV1TranscriptionConfigurations - name: MediaV1TranscriptionDefaultSettings +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_messaging_bulk_v1.yaml b/spec/yaml/twilio_messaging_bulk_v1.yaml index 9b63e2fc..e66029d8 100644 --- a/spec/yaml/twilio_messaging_bulk_v1.yaml +++ b/spec/yaml/twilio_messaging_bulk_v1.yaml @@ -1,4 +1,6 @@ openapi: 3.0.3 +security: +- accountSid_authToken: [] info: title: Bulk Messaging and Broadcast description: Bulk Sending is a public Twilio REST API for 1:Many Message creation @@ -226,6 +228,17 @@ paths: description: Idempotency key provided by the client security: - accountSid_authToken: [] + /v1/Broadcasts/{BroadcastSid}/Cancel: + parameters: + - schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^BC[0-9a-fA-F]{32}$ + name: BroadcastSid + description: Id of an existing Broadcast. + in: path + required: true components: schemas: messaging.v1.Message: @@ -331,10 +344,11 @@ components: type: integer description: Number of recipients with messages unsuccessfully sent to them, producing an error - errors_file: + results_file: type: string format: uri - description: Path to a file detailing errors from Broadcast execution + description: Path to a file detailing successful requests and errors from + Broadcast execution messaging.v1.Error: title: Error type: object @@ -354,5 +368,5 @@ components: description: More information on the error securitySchemes: accountSid_authToken: - type: http scheme: basic + type: http diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index b5941404..fec81927 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -345,6 +345,7 @@ components: type: string format: uri nullable: true + description: The absolute URL of the ChannelSender resource. messaging.v1.deactivation: type: object properties: @@ -1070,6 +1071,11 @@ 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 @@ -1158,6 +1164,20 @@ components: nullable: true description: Indicates that this SMS campaign will send messages that contain phone numbers. + subscriber_opt_in: + type: boolean + nullable: true + description: A boolean that specifies whether campaign has Subscriber Optin + or not. + age_gated: + type: boolean + nullable: true + description: A boolean that specifies whether campaign is age gated or not. + direct_lending: + type: boolean + nullable: true + description: A boolean that specifies whether campaign allows direct lending + or not. campaign_status: type: string nullable: true @@ -1471,12 +1491,12 @@ paths: value: meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: alpha_senders - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0 alpha_senders: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -2412,12 +2432,12 @@ paths: value: meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: senders - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0 senders: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -3335,12 +3355,12 @@ paths: value: meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: phone_numbers - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0 phone_numbers: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -3712,12 +3732,12 @@ paths: value: meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: services - url: https://messaging.twilio.com/v1/Services?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services?PageSize=20&Page=0 services: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My Service! @@ -4178,12 +4198,12 @@ paths: value: meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: short_codes - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0 short_codes: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4352,6 +4372,7 @@ paths: rejection_reason: null error_code: null edit_expiration: null + edit_allowed: null resource_links: customer_profile: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4422,6 +4443,7 @@ paths: rejection_reason: null error_code: null edit_expiration: null + edit_allowed: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: null @@ -4519,6 +4541,12 @@ 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'. examples: update: value: @@ -4547,6 +4575,27 @@ paths: OptInType: VERBAL MessageVolume: 1,000 AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy + EditReason: Website fixed + delete: + description: '' + tags: + - MessagingV1TollfreeVerification + parameters: + - name: Sid + in: path + description: The unique string to identify Tollfree Verification. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^HH[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteTollfreeVerification /v1/Tollfree/Verifications: servers: - url: https://messaging.twilio.com @@ -4686,6 +4735,7 @@ paths: rejection_reason: null error_code: null edit_expiration: null + edit_allowed: null resource_links: customer_profile: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4745,6 +4795,7 @@ paths: rejection_reason: null error_code: null edit_expiration: null + edit_allowed: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 @@ -4787,6 +4838,7 @@ paths: rejection_reason: null error_code: null edit_expiration: null + edit_allowed: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 @@ -5010,6 +5062,9 @@ paths: us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: false + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5055,6 +5110,9 @@ paths: us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5105,6 +5163,9 @@ paths: us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5245,6 +5306,18 @@ paths: keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum. + SubscriberOptIn: + type: boolean + description: A boolean that specifies whether campaign has Subscriber + Optin or not. + AgeGated: + type: boolean + description: A boolean that specifies whether campaign is age gated + or not. + DirectLending: + type: boolean + description: A boolean that specifies whether campaign allows direct + lending or not. required: - BrandRegistrationSid - Description @@ -5281,6 +5354,9 @@ paths: - HELP HasEmbeddedLinks: true HasEmbeddedPhone: false + SubscriberOptIn: false + AgeGated: false + DirectLending: false createWithDefaults: value: BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -5299,6 +5375,8 @@ paths: - START HasEmbeddedLinks: true HasEmbeddedPhone: false + AgeGated: false + DirectLending: false createWithDefaultsSoleProprietor: value: BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -5317,6 +5395,8 @@ paths: - START HasEmbeddedLinks: true HasEmbeddedPhone: false + AgeGated: false + DirectLending: false get: description: '' tags: @@ -5402,6 +5482,9 @@ paths: us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5436,11 +5519,11 @@ paths: errors: [] meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 previous_page_url: null next_page_url: null - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 key: compliance readFailed: value: @@ -5457,6 +5540,9 @@ paths: us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5497,11 +5583,11 @@ paths: it was rejected due to Disallowed Content. meta: page: 0 - page_size: 50 - first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + page_size: 20 + first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 previous_page_url: null next_page_url: null - url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=50&Page=0 + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 key: compliance description: OK security: @@ -5594,6 +5680,9 @@ paths: us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5640,6 +5729,9 @@ paths: us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5684,6 +5776,9 @@ paths: us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false + subscriber_opt_in: true + age_gated: false + direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false @@ -5724,6 +5819,153 @@ paths: security: - accountSid_authToken: [] operationId: FetchUsAppToPerson + post: + description: '' + tags: + - MessagingV1UsAppToPerson + parameters: + - name: MessagingServiceSid + in: path + description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) + to update the resource from. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^MG[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^QE[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' + examples: + update: + value: + sid: QE2c6890da8086d771620e9b13fadeba0b + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Send marketing messages about sales to opted in customers. + message_samples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + us_app_to_person_usecase: MARKETING + has_embedded_links: true + has_embedded_phone: false + campaign_status: PENDING + campaign_id: CFOOBAR + is_externally_registered: false + rate_limits: + att: + mps: 600 + msg_class: A + tmobile: + brand_tier: TOP + subscriber_opt_in: false + age_gated: false + direct_lending: false + date_created: '2021-02-18T14:48:52Z' + date_updated: '2021-02-18T14:48:52Z' + url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b + message_flow: End users opt-in by visiting www.example.com and + adding their phone number. They then check a box agreeing to + receive text messages from Example Brand. Additionally, end + users can also opt-in by texting START to (111) 222-3333 to + opt in. + opt_in_message: 'Acme Corporation: You are now opted-in. For help, + reply HELP. To opt-out, reply STOP' + opt_out_message: You have successfully been unsubscribed from + Acme Corporation. You will not receive any more messages from + this number. + opt_in_keywords: + - START + opt_out_keywords: + - STOP + help_keywords: + - HELP + help_message: 'Acme Corporation: Please visit www.example.com + to get support. To opt-out, reply STOP.' + mock: false + errors: [] + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateUsAppToPerson + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateUsAppToPersonRequest + properties: + HasEmbeddedLinks: + type: boolean + description: Indicates that this SMS campaign will send messages + that contain links. + HasEmbeddedPhone: + type: boolean + description: Indicates that this SMS campaign will send messages + that contain phone numbers. + MessageSamples: + type: array + items: + type: string + description: 'An array of sample message strings, min two and max + five. Min length for each sample: 20 chars. Max length for each + sample: 1024 chars.' + MessageFlow: + type: string + description: Required for all Campaigns. Details around how a consumer + opts-in to their campaign, therefore giving consent to receive + their messages. If multiple opt-in methods can be used for the + same campaign, they must all be listed. 40 character minimum. + 2048 character maximum. + Description: + type: string + description: 'A short description of what this SMS campaign does. + Min length: 40 characters. Max length: 4096 characters.' + AgeGated: + type: boolean + description: A boolean that specifies whether campaign requires + age gate for federally legal content. + DirectLending: + type: boolean + description: A boolean that specifies whether campaign allows direct + lending or not. + required: + - HasEmbeddedLinks + - HasEmbeddedPhone + - MessageSamples + - MessageFlow + - Description + - AgeGated + - DirectLending + examples: + update: + value: + Description: Send marketing messages about sales to opted in customers. + MessageSamples: + - 'EXPRESS: Denim Days Event is ON' + - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' + MessageFlow: End users opt-in by visiting www.example.com and adding + their phone number. They then check a box agreeing to receive + text messages from Example Brand. Additionally, end users can + also opt-in by texting START to (111) 222-3333 to opt in. + HasEmbeddedLinks: true + HasEmbeddedPhone: false + AgeGated: false + DirectLending: false /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases: servers: - url: https://messaging.twilio.com @@ -6054,3 +6296,5 @@ tags: - name: MessagingV1Usecase - name: MessagingV1WhatsappSender - name: MessagingV1WhatsappTemplate +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index ec5e05b3..215919a9 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -721,7 +721,7 @@ paths: app_manifests: mapping: app_sid: sid - resource_url: /v1None + resource_url: /v1/Apps/{app_sid}/Manifest pathType: list get: description: Retrieve a list of all Apps for an Account. @@ -830,7 +830,7 @@ paths: app_manifests: mapping: app_sid: sid - resource_url: /v1None + resource_url: /v1/Apps/{app_sid}/Manifest pathType: instance get: description: Fetch a specific App. @@ -1769,3 +1769,5 @@ tags: - name: MicrovisorV1DeviceConfig - name: MicrovisorV1DeviceSecret - name: MicrovisorV1LoggingToken +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index d676dcc7..c93f7063 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -801,3 +801,5 @@ servers: tags: - name: MonitorV1Alert - name: MonitorV1Event +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 51667f3d..70f8a624 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -72,6 +72,10 @@ components: [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service. + x-twilio: + pii: + handling: standard + deleteSla: 120 binding_type: type: string nullable: true @@ -84,6 +88,10 @@ components: FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format. + x-twilio: + pii: + handling: sensitive + deleteSla: 120 tags: type: array items: @@ -92,6 +100,10 @@ components: description: The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed. + x-twilio: + pii: + handling: standard + deleteSla: 120 url: type: string format: uri @@ -208,6 +220,10 @@ components: description: The list of `identity` values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list. + x-twilio: + pii: + handling: standard + deleteSla: 120 tags: type: array items: @@ -216,6 +232,10 @@ components: description: The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property. + x-twilio: + pii: + handling: standard + deleteSla: 120 segments: type: array items: @@ -258,6 +278,10 @@ components: For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification. + x-twilio: + pii: + handling: standard + deleteSla: 0 sound: type: string nullable: true @@ -393,7 +417,7 @@ components: maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set. facebook_messenger_page_id: @@ -733,6 +757,10 @@ paths: type: array items: type: string + x-twilio: + pii: + handling: standard + deleteSla: 120 examples: readEmpty: value: @@ -1335,12 +1363,12 @@ paths: description: 'The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the - Twilio [Message](https://www.twilio.com/docs/sms/send-messages) - resource. These parameters of the Message resource are supported - in snake case format: `body`, `media_urls`, `status_callback`, - and `max_price`. The `status_callback` parameter overrides the - corresponding parameter in the messaging service, if configured. - The `media_urls` property expects a JSON array.' + Twilio [Message](https://www.twilio.com/docs/sms/quickstart) resource. These + parameters of the Message resource are supported in snake case + format: `body`, `media_urls`, `status_callback`, and `max_price`. The + `status_callback` parameter overrides the corresponding parameter + in the messaging service, if configured. The `media_urls` property + expects a JSON array.' FacebookMessenger: description: Deprecated. Fcm: @@ -1506,7 +1534,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: @@ -1869,7 +1897,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ - description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) + description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications. FacebookMessengerPageId: @@ -1943,3 +1971,5 @@ tags: - name: NotifyV1Service - name: NotifyV1User - name: NotifyV1UserBinding +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index ee2dcad3..86268694 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -208,11 +208,74 @@ components: maxLength: 34 pattern: ^KW[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Port In request, It is the request identifier + description: The SID of the Port In request. This is a unique identifier + of the port in request. url: type: string format: uri nullable: true + numbers.v1.porting_port_in_fetch: + type: object + properties: + port_in_request_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KW[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Port In request. This is a unique identifier + of the port in request. + url: + type: string + format: uri + nullable: true + description: The URL of this Port In request + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The Account SID that the numbers will be added to after they + are ported into Twilio. + notification_emails: + type: array + items: + type: string + nullable: true + description: List of emails for getting notifications about the LOA signing + process. Allowed Max 10 emails. + target_port_in_date: + type: string + format: date + nullable: true + description: Minimum number of days in the future (at least 2 days) needs + to be established with the Ops team for validation. + target_port_in_time_range_start: + type: string + nullable: true + description: Minimum hour in the future needs to be established with the + Ops team for validation. + target_port_in_time_range_end: + type: string + nullable: true + description: Maximum hour in the future needs to be established with the + Ops team for validation. + losing_carrier_information: + nullable: true + description: 'The information for the losing carrier. ' + phone_numbers: + type: array + items: {} + nullable: true + description: The list of phone numbers to Port in. Phone numbers are in + E.164 format (e.g. +16175551212). + documents: + type: array + items: + type: string + nullable: true + description: The list of documents SID referencing a utility bills numbers.v1.porting_portability: type: object properties: @@ -567,7 +630,7 @@ paths: mountName: porting_port_ins pathType: list post: - description: 'Allows to create a port in request ' + description: Allows to create a new port in request tags: - NumbersV1PortingPortIn responses: @@ -580,11 +643,80 @@ paths: create: value: port_in_request_sid: KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://numbers.twilio.com/v1/Porting/PortIn + url: https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Accepted security: - accountSid_authToken: [] operationId: CreatePortingPortIn + /v1/Porting/PortIn/{PortInRequestSid}: + servers: + - url: https://numbers.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - port_in_request_sid + mountName: porting_port_ins + className: porting_port_in_fetch + pathType: instance + get: + description: Fetch a port in request by SID + tags: + - NumbersV1PortingPortInFetch + parameters: + - name: PortInRequestSid + in: path + description: The SID of the Port In request. This is a unique identifier of + the port in request. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^KW[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/numbers.v1.porting_port_in_fetch' + examples: + fetch: + value: + port_in_request_sid: KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + notification_emails: + - user@domain.com + target_port_in_date: '2023-09-10' + target_port_in_time_range_start: 10:00:00+01:00 + target_port_in_time_range_end: 20:00:00+01:00 + losing_carrier_information: + customer_type: Business/Individual + customer_name: Customer name for carrier + authorized_representative: John Smith + authorized_representative_email: signer@domain.com + account_number: '123456' + account_telephone_number: '+133232323' + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address: + street: Your Street + street_2: Other Street or null + city: City + state: State + zip: '000000' + country: US + phone_numbers: + - phone_number: '+16175551212' + pin: '123456' + portable: true + not_portability_reason: string + not_portability_reason_code: 0 + documents: + - ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPortingPortInFetch /v1/Porting/Portability/PhoneNumber/{PhoneNumber}: servers: - url: https://numbers.twilio.com @@ -654,5 +786,8 @@ tags: - name: NumbersV1Identity - name: NumbersV1PortingBulkPortability - name: NumbersV1PortingPortIn +- name: NumbersV1PortingPortInFetch - name: NumbersV1PortingPortability - name: NumbersV1ProofOfAddress +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index bcc370f1..e6412fa8 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -34,6 +34,10 @@ 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,6 +45,10 @@ 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 @@ -90,11 +98,19 @@ 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 @@ -123,6 +139,10 @@ 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: @@ -382,6 +402,10 @@ 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' @@ -411,6 +435,10 @@ 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: @@ -418,6 +446,10 @@ 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 @@ -472,6 +504,10 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -632,6 +668,10 @@ 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 @@ -652,6 +692,10 @@ 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' @@ -682,6 +726,10 @@ 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: @@ -689,6 +737,10 @@ 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 @@ -944,6 +996,10 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -1111,6 +1167,10 @@ paths: description: Email that this AuthorizationDocument will be sent to for signing. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: test+hosted@twilio.com @@ -2209,6 +2269,10 @@ paths: description: A human readable description of this resource, up to 128 characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: example @@ -3496,6 +3560,10 @@ paths: schema: type: string format: phone-number + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: '+19193608000' @@ -3516,6 +3584,10 @@ paths: description: A human readable description of this resource, up to 128 characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: example @@ -4184,13 +4256,22 @@ paths: end_user: - name: Individual type: individual + requirement_name: individual_info url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual fields: - first_name - last_name + detailed_fields: + - machine_name: first_name + friendly_name: First Name + description: First name of the Individual + - machine_name: last_name + friendly_name: Last Name + description: Last name of the Individual supporting_document: - - name: Address type: document + requirement_name: proof_of_address description: The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable @@ -4199,7 +4280,12 @@ paths: - name: Address Validation type: address url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address - fields: [] + fields: + - address_sids + detailed_fields: + - machine_name: address_sids + friendly_name: Address sid(s) + description: Address sid of the individual url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 @@ -4255,13 +4341,22 @@ paths: end_user: - name: Individual type: individual + requirement_name: individual_info url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual fields: - first_name - last_name + detailed_fields: + - machine_name: first_name + friendly_name: First Name + description: First name of the Individual + - machine_name: last_name + friendly_name: Last Name + description: Last name of the Individual supporting_document: - - name: Address type: document + requirement_name: proof_of_address description: The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where @@ -4270,7 +4365,12 @@ paths: - name: Address Validation type: address url: https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address - fields: [] + fields: + - address_sids + detailed_fields: + - machine_name: address_sids + friendly_name: Address sid(s) + description: Address sid of the individual url: https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: @@ -4837,3 +4937,5 @@ tags: - name: NumbersV2ReplaceItems - name: NumbersV2SupportingDocument - name: NumbersV2SupportingDocumentType +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_oauth_v1.yaml b/spec/yaml/twilio_oauth_v1.yaml deleted file mode 100644 index 0c9e1e96..00000000 --- a/spec/yaml/twilio_oauth_v1.yaml +++ /dev/null @@ -1,503 +0,0 @@ -components: - securitySchemes: - accountSid_authToken: - scheme: basic - type: http - 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 -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.0.0 -openapi: 3.0.1 -paths: - /v1/certs: - servers: - - url: https://oauth.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - keys - mountName: oauth - pathType: instance - get: - description: Fetches public JWKs - tags: - - OauthV1Oauth - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/oauth.v1.certs' - examples: - fetch: - value: - keys: - - alg: ES256 - kid: IC10c8172f35dd36f20d9ed2fcc0b818c7 - key_ops: [] - use: sig - crv: P-256 - x: hrJ4NKauVYBiREgIY_EPPj10zHIiOHeIf3-LGODt_KM - y: c3IcyhpvfMIMpqd_ku9Q_4n20nMlelUF-zSmRXEIFEU - kty: EC - url: https://oauth.twilio.com/v1/certs - description: OK - security: - - accountSid_authToken: [] - operationId: FetchCerts - /v1/device/code: - servers: - - url: https://oauth.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - device_code - - user_code - - verification_uri - - verification_uri_complete - - expires_in - - interval - mountName: device_code - pathType: list - 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' - examples: - create: - value: - device_code: LiwuhE0bIhqemK6sd34tXfobVCR9yrk0 - user_code: Hkf1WaID3 - verification_uri: v1/oauth2/device/activate - verification_uri_complete: v1/oauth2/device/activate?user_code=Hkf1WaID3 - expires_in: 299 - interval: 5 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeviceCode - 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 - examples: - create: - value: - ClientSid: OQ693217fa7610373e7762f06645058bac - Scopes: - - test-scope - Audiences: - - http://dev.twilio.com/ - /v1/.well-known/openid-configuration: - servers: - - url: https://oauth.twilio.com - description: '' - 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 - mountName: openid_discovery - pathType: instance - 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' - examples: - fetch: - value: - issuer: https://iam.twilio.com - authorization_endpoint: https://oauth.twilio.com/oauth2/authorize - device_authorization_endpoint: https://oauth.twilio.com/oauth2/device/authorize - token_endpoint: https://oauth.twilio.com/oauth2/token - userinfo_endpoint: https://oauth.twilio.com/oauth2/userinfo - revocation_endpoint: https://oauth.twilio.com/oauth2/revoke - jwk_uri: https://oauth.twilio.com/oauth2/certs - response_type_supported: - - code - - token - subject_type_supported: - - account_sid - - user_sid - id_token_signing_alg_values_supported: - - ECDSA - - RSA256 - scopes_supported: - - openid - - profile - - email - claims_supported: - - act - - aud - - cid - - device_id - - exp - - jti - - iat - - iss - - nbf - - scp - - sub - url: https://oauth.twilio.com/v1/.well-known/openid-configuration - description: OK - security: - - accountSid_authToken: [] - operationId: FetchOpenidDiscovery - /v1/token: - servers: - - url: https://oauth.twilio.com - description: '' - 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' - examples: - create: - value: - access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c - refresh_token: ghjbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c - id_token: eyJhbdGciOiIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c - refresh_token_expires_at: '2015-07-31T04:00:00Z' - access_token_expires_at: '2015-07-31T04:00:00Z' - description: Created - security: - - accountSid_authToken: [] - operationId: CreateToken - 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 - examples: - create: - value: - GrantType: authorization_code - ClientSid: OQ09708361261756db8c0b555d36f55a65 - ClientSecret: client_secret - Code: dfyguyhuijikokje456rt7y8uioklj - CodeVerifier: code_verifier - DeviceCode: device_code - RefreshToken: refresh_token - DeviceId: device_id - /v1/userinfo: - servers: - - url: https://oauth.twilio.com - description: '' - x-twilio: - defaultOutputProperties: - - user_sid - mountName: user_info - pathType: instance - 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' - examples: - fetch: - value: - user_sid: US57cc2449f1b38ed85cf1a43cd8166349 - first_name: Mafalda - last_name: Rolfson - friendly_name: mafalda.rolfson+oBgz@ct.sink.twilio.com - email: mafalda.rolfson+oBgz@ct.sink.twilio.com - url: https://oauth.twilio.com/v1/userinfo - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUserInfo -servers: -- url: https://oauth.twilio.com -tags: -- name: OauthV1DeviceCode -- name: OauthV1Oauth -- name: OauthV1OpenidDiscovery -- name: OauthV1Token -- name: OauthV1UserInfo diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index 213eabdf..ba0a1e08 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -342,6 +342,10 @@ 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,6 +353,10 @@ 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 @@ -443,12 +451,20 @@ 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' @@ -483,6 +499,10 @@ 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: @@ -490,6 +510,10 @@ 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' @@ -611,12 +635,20 @@ 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' @@ -652,6 +684,10 @@ 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: @@ -659,6 +695,10 @@ 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 @@ -1334,3975 +1374,518 @@ components: format: uri nullable: true description: Contains an absolute URL for this Sync Map Permission. - preview.understand.assistant: + preview.wireless.command: type: object properties: - account_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Account that created this 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 + pattern: ^DC[0-9a-fA-F]{32}$ nullable: true - description: The date that this resource was last updated - friendly_name: + account_sid: type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: A text description for the Assistant. It is non-unique and - can up to 255 characters long. - latest_model_build_sid: + device_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID (Sid) of the latest model build. Null if no model - has been built. - links: - type: object - format: uri-map - nullable: true - log_queries: - type: boolean + pattern: ^DE[0-9a-fA-F]{32}$ 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: + sim_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: + command: type: string 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. - url: + command_mode: type: string - format: uri nullable: true - callback_url: + status: type: string - format: uri nullable: true - description: A user-provided URL to send event callbacks to. - callback_events: + direction: type: string nullable: true - description: Space-separated list of callback events that will trigger callbacks. - preview.understand.assistant.assistant_fallback_actions: - type: object - properties: - account_sid: + date_created: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: date-time nullable: true - assistant_sid: + date_updated: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + format: date-time nullable: true url: type: string format: uri nullable: true - data: - nullable: true - preview.understand.assistant.assistant_initiation_actions: + preview.wireless.rate_plan: type: object properties: - account_sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - assistant_sid: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - url: + unique_name: type: string - format: uri - nullable: true - data: nullable: true - preview.understand.assistant.dialogue: - type: object - properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Account that created this Field. - assistant_sid: + friendly_name: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the parent Assistant. - sid: + data_enabled: + type: boolean + nullable: true + data_metering: type: string - minLength: 34 - maxLength: 34 - pattern: ^UK[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Dialogue - data: + data_limit: + type: integer nullable: true - description: The dialogue memory object as json - url: - type: string - format: uri + messaging_enabled: + type: boolean 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}$ + voice_enabled: + type: boolean + nullable: true + national_roaming_enabled: + type: boolean + nullable: true + international_roaming: + type: array + items: + type: string 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 - 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: + url: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + format: uri nullable: true - description: The unique ID of the parent Assistant. + preview.wireless.sim: + type: object + properties: sid: type: string minLength: 34 maxLength: 34 - pattern: ^UE[0-9a-fA-F]{32}$ + pattern: ^DE[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 - format: uri - nullable: true - preview.understand.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 unique ID of the Account that created this Field Type. - date_created: + rate_plan_sid: type: string - format: date-time + minLength: 34 + maxLength: 34 + pattern: ^WP[0-9a-fA-F]{32}$ nullable: true - description: The date that this resource was created - date_updated: + friendly_name: type: string - format: date-time nullable: true - description: The date that this resource was last updated - friendly_name: + iccid: 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 + e_id: + type: string nullable: true - assistant_sid: + status: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the Assistant. - sid: + commands_callback_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ + format: uri nullable: true - description: A 34 character string that uniquely identifies this resource. - unique_name: + commands_callback_method: 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: + 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 - preview.understand.assistant.field_type.field_value: - type: object - properties: - account_sid: + sms_method: type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - description: The unique ID of the Account that created this Field Value. - date_created: + sms_url: type: string - format: date-time + format: uri nullable: true - description: The date that this resource was created - date_updated: + voice_fallback_method: type: string - format: date-time + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - description: The date that this resource was last updated - field_type_sid: + voice_fallback_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^UB[0-9a-fA-F]{32}$ + format: uri nullable: true - description: The unique ID of the Field Type associated with this Field - Value. - language: + voice_method: type: string + format: http-method + enum: + - HEAD + - GET + - POST + - PATCH + - PUT + - DELETE nullable: true - description: An ISO language-country string of the value. - assistant_sid: + voice_url: type: string - minLength: 34 - maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + format: uri nullable: true - description: The unique ID of the Assistant. - sid: + date_created: type: string - minLength: 34 - maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ + format: date-time nullable: true - description: A 34 character string that uniquely identifies this resource. - value: + date_updated: type: string + format: date-time nullable: true - description: The Field Value itself. url: type: string format: uri nullable: true - synonym_of: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UC[0-9a-fA-F]{32}$ + links: + type: object + format: uri-map 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: + preview.wireless.sim.usage: type: object properties: - account_sid: + sim_sid: type: string minLength: 34 maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - nullable: true - description: The unique ID of the Account that created this Model Build. - date_created: - type: string - format: date-time + pattern: ^DE[0-9a-fA-F]{32}$ nullable: true - description: The date that this resource was created - date_updated: + sim_unique_name: type: string - format: date-time nullable: true - description: The date that this resource was last updated - assistant_sid: + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^UA[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique ID of the parent Assistant. - sid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UG[0-9a-fA-F]{32}$ + period: nullable: true - description: A 34 character string that uniquely identifies this resource. - status: - type: string - $ref: '#/components/schemas/model_build_enum_status' + commands_usage: nullable: true - description: 'A string that described the model build status. The values - can be: enqueued, building, completed, failed' - unique_name: - type: string + commands_costs: + nullable: true + data_usage: + nullable: true + data_costs: 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 - 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 -info: - title: Twilio - Preview - description: This is the public Twilio REST API. - termsOfService: https://www.twilio.com/legal/tos - contact: - name: Twilio Support - url: https://support.twilio.com - email: support@twilio.com - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.0.0 -openapi: 3.0.1 -paths: - /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - get: - description: Fetch information about a specific Certificate credential in the - Fleet. - tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: 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' - examples: - fetch: - value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesCertificate - delete: - description: Unregister a specific Certificate credential from the Fleet, effectively - disallowing any inbound client connections that are presenting it. - tags: - - PreviewDeployedDevicesCertificate - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: 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 - 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' - examples: - update: - value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesCertificate - 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. - examples: - update: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - /DeployedDevices/Fleets/{FleetSid}/Certificates: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - post: - description: Enroll a new Certificate credential to the Fleet, optionally giving - it a friendly name and assigning to a Device. - 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' - examples: - create: - value: - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesCertificate - 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 - examples: - create: - value: - CertificateData: 12345678abcdef - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - certificates: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - key: certificates - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - readFull: - value: - certificates: - - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - thumbprint: '1234567890' - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - key: certificates - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesCertificate - /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDeployment - 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 - 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' - examples: - update: - value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDeployment - 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. - examples: - update: - value: - FriendlyName: friendly_name - SyncServiceSid: sync_service_sid - /DeployedDevices/Fleets/{FleetSid}/Deployments: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - post: - description: Create a new Deployment in the Fleet, optionally giving it a friendly - name and linking to a specific Twilio Sync service instance. - 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' - examples: - create: - value: - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesDeployment - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesDeploymentRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Deployment, up to 256 characters long. - SyncServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of the Twilio - Sync service instance that will be linked to and accessible by - this Deployment. - examples: - create: - value: - FriendlyName: friendly_name - SyncServiceSid: sync_service_sid - get: - description: Retrieve a list of all Deployments belonging to the Fleet. - tags: - - PreviewDeployedDevicesDeployment - parameters: - - name: FleetSid - in: path - description: '' - 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - deployments: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - key: deployments - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - readFull: - value: - deployments: - - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - key: deployments - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesDeployment - /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - 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' - examples: - fetch: - value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesDevice - delete: - description: Delete a specific Device from the Fleet, also removing it from - associated Deployments. - tags: - - PreviewDeployedDevicesDevice - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Device resource. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesDevice - post: - description: 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' - examples: - update: - value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesDevice - 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: '' - examples: - update: - value: - FriendlyName: friendly_name - Identity: identity - /DeployedDevices/Fleets/{FleetSid}/Devices: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - 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' - examples: - create: - value: - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesDevice - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesDeviceRequest - properties: - UniqueName: - type: string - description: Provides a unique and addressable name to be assigned - to this Device, to be used in addition to SID, up to 128 characters - long. - FriendlyName: - type: string - description: Provides a human readable descriptive text to be assigned - to this Device, up to 256 characters long. - Identity: - type: string - description: Provides an arbitrary string identifier representing - a human user to be associated with this Device, up to 256 characters - long. - DeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Specifies the unique string identifier of the Deployment - group that this Device is going to be associated with. - Enabled: - type: boolean - description: '' - examples: - create: - value: - FriendlyName: friendly_name - UniqueName: unique_name - Identity: identity - get: - description: Retrieve a list of 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - devices: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - key: devices - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - readFull: - value: - devices: - - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - enabled: true - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: bob@twilio.com - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - date_authenticated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - key: devices - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesDevice - /DeployedDevices/Fleets/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - devices: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices - deployments: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments - certificates: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates - keys: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys - pathType: instance - 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' - examples: - fetch: - value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesFleet - delete: - description: 'Delete a specific Fleet from your account, also destroys all nested - resources: Devices, Deployments, Certificates, Keys.' - tags: - - PreviewDeployedDevicesFleet - parameters: - - name: Sid - in: path - description: Provides a 34 character string that uniquely identifies the requested - Fleet resource. - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteDeployedDevicesFleet - post: - description: 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' - examples: - update: - value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesFleet - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesFleetRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - DefaultDeploymentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^DL[0-9a-fA-F]{32}$ - description: Provides a string identifier of a Deployment that is - going to be used as a default one for this Fleet. - examples: - update: - value: - FriendlyName: friendly_name - DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /DeployedDevices/Fleets: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - devices: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices - deployments: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments - certificates: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates - keys: - mapping: - fleet_sid: sid - resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys - pathType: list - post: - description: Create a new Fleet for scoping of deployed devices within your - account. - tags: - - PreviewDeployedDevicesFleet - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet' - examples: - create: - value: - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesFleet - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesFleetRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Fleet, up to 256 characters long. - examples: - create: - value: - FriendlyName: friendly_name - get: - description: 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - fleets: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - key: fleets - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - readFull: - value: - fleets: - - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices - deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments - certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates - keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - key: fleets - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesFleet - /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: instance - get: - description: Fetch information about a specific Key credential in the Fleet. - tags: - - PreviewDeployedDevicesKey - parameters: - - name: 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' - examples: - fetch: - value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchDeployedDevicesKey - 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 - 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' - examples: - update: - value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateDeployedDevicesKey - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateDeployedDevicesKeyRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - examples: - update: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - /DeployedDevices/Fleets/{FleetSid}/Keys: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Fleets/{Sid} - pathType: list - post: - description: Create a new Key credential in the Fleet, optionally giving it - a friendly name and assigning to a Device. - tags: - - PreviewDeployedDevicesKey - parameters: - - name: FleetSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.deployed_devices.fleet.key' - examples: - create: - value: - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateDeployedDevicesKey - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateDeployedDevicesKeyRequest - properties: - FriendlyName: - type: string - description: Provides a human readable descriptive text for this - Key credential, up to 256 characters long. - DeviceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^TH[0-9a-fA-F]{32}$ - description: Provides the unique string identifier of an existing - Device to become authenticated with this Key credential. - examples: - create: - value: - DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FriendlyName: friendly_name - get: - description: Retrieve a list of all Keys credentials belonging to the Fleet. - tags: - - PreviewDeployedDevicesKey - parameters: - - name: 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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - keys: [] - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - key: keys - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - readFull: - value: - keys: - - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - secret: null - date_created: '2016-07-30T20:00:00Z' - date_updated: '2016-07-30T20:00:00Z' - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - meta: - first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - key: keys - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 - description: OK - security: - - accountSid_authToken: [] - operationId: ListDeployedDevicesKey - /HostedNumbers/AuthorizationDocuments/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - dependent_hosted_number_orders: - mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders - pathType: instance - 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' - examples: - fetch: - value: - address_sid: AD11111111111111111111111111111111 - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchHostedNumbersAuthorizationDocument - post: - description: Updates a specific AuthorizationDocument. - 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' - examples: - update: - value: - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateHostedNumbersAuthorizationDocument - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateHostedNumbersAuthorizationDocumentRequest - properties: - HostedNumberOrderSids: - type: array - items: - type: string - description: A list of HostedNumberOrder sids that this AuthorizationDocument - will authorize for hosting phone number capabilities on Twilio's - platform. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: A 34 character string that uniquely identifies the - Address resource that is associated with this AuthorizationDocument. - Email: - type: string - description: Email that this AuthorizationDocument will be sent - to for signing. - CcEmails: - type: array - items: - type: string - description: Email recipients who will be informed when an Authorization - Document has been sent and signed - Status: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - description: 'Status of an instance resource. It can hold one of - the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, - 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - ContactTitle: - type: string - description: The title of the person authorized to sign the Authorization - Document for this phone number. - ContactPhoneNumber: - type: string - description: The contact phone number of the person authorized to - sign the Authorization Document. - examples: - update: - value: - AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - HostedNumberOrderSids: - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 - Status: signing - ContactTitle: Mr. - ContactPhoneNumber: '+14155555555' - /HostedNumbers/AuthorizationDocuments: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - dependent_hosted_number_orders: - mapping: - signing_document_sid: sid - resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders - pathType: list - 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 - examples: - readEmpty: - value: test+hosted@twilio.com - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/authorization_document_enum_status' - examples: - readEmpty: - value: signed - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListHostedNumbersAuthorizationDocumentResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 - items: [] - readFull: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 - items: - - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersAuthorizationDocument - 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' - examples: - create: - value: - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - links: - dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders - sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: signing - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateHostedNumbersAuthorizationDocument - 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 - examples: - create: - value: - AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - HostedNumberOrderSids: - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 - - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 - ContactTitle: Mr. - ContactPhoneNumber: '+14155555555' - /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /AuthorizationDocuments/{Sid} - pathType: list - get: - description: Retrieve a list of dependent HostedNumberOrders belonging to the - AuthorizationDocument. - tags: - - PreviewHostedNumbersDependentHostedNumberOrder - parameters: - - name: SigningDocumentSid - in: path - description: A 34 character string that uniquely identifies the LOA document - associated with this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PX[0-9a-fA-F]{32}$ - required: true - - name: Status - in: query - description: 'Status of an instance resource. It can hold one of the values: - 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section - entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) - for more information on each of these statuses.' - schema: - type: string - $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' - examples: - readEmpty: - value: completed - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - examples: - readEmpty: - value: '+19193608000' - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - examples: - readEmpty: - value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - examples: - readEmpty: - value: example - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - examples: - readEmpty: - value: something123 - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '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: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 - items: [] - readFull: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 - items: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '1234' - friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - failure_reason: '' - unique_name: foobar - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersDependentHostedNumberOrder - /HostedNumbers/HostedNumberOrders/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '5105' - failure_reason: '' - friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - unique_name: foobar - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call - description: OK - security: - - accountSid_authToken: [] - operationId: FetchHostedNumbersHostedNumberOrder - 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 - 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' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - test1@twilio.com - - test2@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test+hosted@twilio.com - extension: '1234' - failure_reason: '' - friendly_name: new friendly name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: pending-loa - unique_name: new unique name - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 1 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateHostedNumbersHostedNumberOrder - 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. - examples: - update: - value: - FriendlyName: new friendly name - UniqueName: new unique name - Email: test+hosted@twilio.com - CcEmails: - - test1@twilio.com - - test2@twilio.com - Status: pending-loa - Extension: '1234' - CallDelay: 15 - /HostedNumbers/HostedNumberOrders: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - pathType: list - get: - description: Retrieve a list of HostedNumberOrders belonging to the account - initiating the request. - tags: - - PreviewHostedNumbersHostedNumberOrder - parameters: - - name: Status - in: query - description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, - `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, - `failed`, or `action-required`. - schema: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_status' - examples: - readEmpty: - value: completed - - name: PhoneNumber - in: query - description: An E164 formatted phone number hosted by this HostedNumberOrder. - schema: - type: string - format: phone-number - examples: - readEmpty: - value: '+19193608000' - - name: IncomingPhoneNumberSid - in: query - description: A 34 character string that uniquely identifies the IncomingPhoneNumber - resource created by this HostedNumberOrder. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^PN[0-9a-fA-F]{32}$ - examples: - readEmpty: - value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz - - name: FriendlyName - in: query - description: A human readable description of this resource, up to 64 characters. - schema: - type: string - examples: - readEmpty: - value: example - - name: UniqueName - in: query - description: Provides a unique and addressable name to be assigned to this - HostedNumberOrder, assigned by the developer, to be optionally used in addition - to SID. - schema: - type: string - examples: - readEmpty: - value: something123 - - name: PageSize - in: query - description: How many resources to return in each list page. The default is - 50, and the maximum is 1000. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Page - in: query - description: The page index. This value is simply for client state. - schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. - schema: - type: string - responses: - '200': - content: - application/json: - schema: - type: object - title: ListHostedNumbersHostedNumberOrderResponse - properties: - items: - type: array - items: - $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object - examples: - readEmpty: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 - items: [] - readFull: - value: - meta: - first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 - key: items - next_page_url: null - page: 0 - page_size: 50 - previous_page_url: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 - items: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 15 - capabilities: - sms: true - voice: false - cc_emails: - - aaa@twilio.com - - bbb@twilio.com - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: '1234' - failure_reason: '' - friendly_name: friendly_name - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: PX11111111111111111111111111111111 - status: received - unique_name: foobar - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - verification_code: '8794' - verification_document_sid: null - verification_type: phone-call - description: OK - security: - - accountSid_authToken: [] - operationId: ListHostedNumbersHostedNumberOrder - 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' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: AD11111111111111111111111111111111 - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: test@twilio.com - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: null - verification_type: phone-call - createWithoutOptionalLoaFields: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: null - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: null - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: null - verification_type: phone-call - createWithPhoneBillVerification: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - address_sid: null - call_delay: 0 - capabilities: - sms: true - voice: false - cc_emails: [] - date_created: '2017-03-28T20:06:39Z' - date_updated: '2017-03-28T20:06:39Z' - email: null - extension: null - failure_reason: '' - friendly_name: null - incoming_phone_number_sid: PN11111111111111111111111111111111 - phone_number: '+14153608311' - sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - signing_document_sid: null - status: received - unique_name: null - url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_attempts: 0 - verification_call_sids: null - verification_code: null - verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - verification_type: phone-bill - description: Created - security: - - accountSid_authToken: [] - operationId: CreateHostedNumbersHostedNumberOrder - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateHostedNumbersHostedNumberOrderRequest - properties: - PhoneNumber: - type: string - format: phone-number - description: The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) - format - SmsCapability: - type: boolean - description: Used to specify that the SMS capability will be hosted - on Twilio's platform. - AccountSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AC[0-9a-fA-F]{32}$ - description: This defaults to the AccountSid of the authorization - the user is using. This can be provided to specify a subaccount - to add the HostedNumberOrder to. - FriendlyName: - type: string - description: A 64 character string that is a human readable text - that describes this resource. - UniqueName: - type: string - description: Optional. Provides a unique and addressable name to - be assigned to this HostedNumberOrder, assigned by the developer, - to be optionally used in addition to SID. - CcEmails: - type: array - items: - type: string - description: Optional. A list of emails that the LOA document for - this HostedNumberOrder will be carbon copied to. - SmsUrl: - type: string - format: uri - description: The URL that Twilio should request when somebody sends - an SMS to the phone number. This will be copied onto the IncomingPhoneNumber - resource. - SmsMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsUrl. Must be either `GET` or `POST`. This will be copied onto - the IncomingPhoneNumber resource. - SmsFallbackUrl: - type: string - format: uri - description: A URL that Twilio will request if an error occurs requesting - or executing the TwiML defined by SmsUrl. This will be copied - onto the IncomingPhoneNumber resource. - SmsFallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: The HTTP method that should be used to request the - SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied - onto the IncomingPhoneNumber resource. - StatusCallbackUrl: - type: string - format: uri - description: Optional. The Status Callback URL attached to the IncomingPhoneNumber - resource. - StatusCallbackMethod: - type: string - format: http-method - enum: - - HEAD - - GET - - POST - - PATCH - - PUT - - DELETE - description: Optional. The Status Callback Method attached to the - IncomingPhoneNumber resource. - SmsApplicationSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AP[0-9a-fA-F]{32}$ - description: Optional. The 34 character sid of the application Twilio - should use to handle SMS messages sent to this number. If a `SmsApplicationSid` - is present, Twilio will ignore all of the SMS urls above and use - those set on the application. - AddressSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^AD[0-9a-fA-F]{32}$ - description: Optional. A 34 character string that uniquely identifies - the Address resource that represents the address of the owner - of this phone number. - Email: - type: string - description: Optional. Email of the owner of this phone number that - is being hosted. - VerificationType: - type: string - $ref: '#/components/schemas/hosted_number_order_enum_verification_type' - description: Optional. The method used for verifying ownership of - the number to be hosted. One of phone-call (default) or phone-bill. - VerificationDocumentSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^RI[0-9a-fA-F]{32}$ - description: Optional. The unique sid identifier of the Identity - Document that represents the document for verifying ownership - of the number to be hosted. Required when VerificationType is - phone-bill. - required: - - PhoneNumber - - SmsCapability - examples: - create: - value: - AddressSid: AD11111111111111111111111111111111 - PhoneNumber: '+14153608311' - SmsCapability: true - Email: test@twilio.com - createWithoutOptionalLoaFields: - value: - PhoneNumber: '+14153608311' - SmsCapability: true - createWithPhoneBillVerification: - value: - PhoneNumber: '+14153608311' - SmsCapability: true - VerificationType: phone-bill - VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /marketplace/AvailableAddOns/{Sid}: +info: + title: Twilio - Preview + description: This is the public Twilio REST API. + termsOfService: https://www.twilio.com/legal/tos + contact: + name: Twilio Support + url: https://support.twilio.com + email: support@twilio.com + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + version: 1.0.0 +openapi: 3.0.1 +paths: + /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + parent: /Fleets/{Sid} pathType: instance get: - description: Fetch an instance of an Add-on currently available to be installed. + description: Fetch information about a specific Certificate credential in the + Fleet. tags: - - PreviewMarketplaceAvailableAddOn + - PreviewDeployedDevicesCertificate parameters: - - name: Sid + - name: FleetSid in: path - description: The SID of the AvailableAddOn resource to fetch. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^XB[0-9a-fA-F]{32}$ - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - examples: - fetch: - value: - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - pricing_type: per minute - configuration_schema: - type: object - properties: - bad_words: - type: boolean - required: - - bad_words - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - description: OK - security: - - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOn - /marketplace/AvailableAddOns: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - available_add_on_sid: sid - resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions - pathType: list - 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. + description: '' schema: - type: integer - minimum: 0 - - name: PageToken - in: query - description: The page token. This is provided by the API. + 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: - type: object - title: ListMarketplaceAvailableAddOnResponse - properties: - available_add_ons: - type: array - items: - $ref: '#/components/schemas/preview.marketplace.available_add_on' - meta: - properties: - first_page_url: - format: uri - type: string - key: - type: string - next_page_url: - format: uri - nullable: true - type: string - page: - type: integer - page_size: - type: integer - previous_page_url: - format: uri - nullable: true - type: string - url: - format: uri - type: string - type: object + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' examples: - readFull: - value: - available_add_ons: - - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - pricing_type: per minute - configuration_schema: - type: object - properties: - bad_words: - type: boolean - required: - - bad_words - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - meta: - page: 0 - page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - next_page_url: null - key: available_add_ons - readEmpty: + fetch: value: - available_add_ons: [] - meta: - page: 0 - page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 - next_page_url: null - key: available_add_ons + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOn - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension - pathType: instance - get: - description: Fetch an instance of an Extension for the Available Add-on. + operationId: FetchDeployedDevicesCertificate + delete: + description: Unregister a specific Certificate credential from the Fleet, effectively + disallowing any inbound client connections that are presenting it. tags: - - PreviewMarketplaceAvailableAddOnExtension + - PreviewDeployedDevicesCertificate parameters: - - name: AvailableAddOnSid + - name: FleetSid in: path - description: The SID of the AvailableAddOn resource with the extension to - fetch. + 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: ^XB[0-9a-fA-F]{32}$ + pattern: ^CY[0-9a-fA-F]{32}$ + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesCertificate + post: + description: Update the given properties of a specific Certificate credential + in the Fleet, giving it a friendly name or assigning to a Device. + tags: + - PreviewDeployedDevicesCertificate + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string required: true - name: Sid in: path - description: The SID of the AvailableAddOn Extension resource to fetch. + description: Provides a 34 character string that uniquely identifies the requested + Certificate credential resource. schema: type: string minLength: 34 maxLength: 34 - pattern: ^XF[0-9a-fA-F]{32}$ + pattern: ^CY[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.deployed_devices.fleet.certificate' examples: - fetch: + update: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceAvailableAddOnExtension - /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + operationId: UpdateDeployedDevicesCertificate + 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. + examples: + update: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + /DeployedDevices/Fleets/{FleetSid}/Certificates: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /AvailableAddOns/{Sid} - className: available_add_on_extension + parent: /Fleets/{Sid} pathType: list + post: + description: Enroll a new Certificate credential to the Fleet, optionally giving + it a friendly name and assigning to a Device. + 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' + examples: + create: + value: + sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesCertificate + 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 + examples: + create: + value: + CertificateData: 12345678abcdef + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: - description: Retrieve a list of Extensions for the Available Add-on. + description: Retrieve a list of all Certificate credentials belonging to the + Fleet. tags: - - PreviewMarketplaceAvailableAddOnExtension + - PreviewDeployedDevicesCertificate parameters: - - name: AvailableAddOnSid + - name: FleetSid in: path - description: The SID of the AvailableAddOn resource with the extensions to - read. + 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: ^XB[0-9a-fA-F]{32}$ - required: true + pattern: ^TH[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5328,12 +1911,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceAvailableAddOnExtensionResponse + title: ListDeployedDevicesCertificateResponse properties: - extensions: + certificates: type: array items: - $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' + $ref: '#/components/schemas/preview.deployed_devices.fleet.certificate' meta: properties: first_page_url: @@ -5358,122 +1941,263 @@ paths: type: string type: object examples: - readFull: + readEmpty: value: - extensions: - - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + certificates: [] meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions - readEmpty: + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + readFull: value: - extensions: [] + certificates: + - sid: CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + thumbprint: '1234567890' + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates/CYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 + key: certificates + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceAvailableAddOnExtension - /marketplace/InstalledAddOns: + operationId: ListDeployedDevicesCertificate + /DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + parent: /Fleets/{Sid} + pathType: instance + 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' + examples: + fetch: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchDeployedDevicesDeployment + 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 + 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' + examples: + update: + value: + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: UpdateDeployedDevicesDeployment + 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. + examples: + update: + value: + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid + /DeployedDevices/Fleets/{FleetSid}/Deployments: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Fleets/{Sid} pathType: list post: - description: Install an Add-on for the Account specified. + description: Create a new Deployment in the Fleet, optionally giving it a friendly + name and linking to a specific Twilio Sync service instance. tags: - - PreviewMarketplaceInstalledAddOn + - PreviewDeployedDevicesDeployment + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' examples: create: value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription_1 - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateMarketplaceInstalledAddOn + operationId: CreateDeployedDevicesDeployment requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateMarketplaceInstalledAddOnRequest + title: CreateDeployedDevicesDeploymentRequest properties: - AvailableAddOnSid: + 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: ^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 + pattern: ^IS[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of the Twilio + Sync service instance that will be linked to and accessible by + this Deployment. examples: create: value: - AvailableAddOnSid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - AcceptTermsOfService: true - Configuration: '{"bad_words": true}' - UniqueName: voicebase_high_accuracy_transcription_1 + FriendlyName: friendly_name + SyncServiceSid: sync_service_sid get: - description: Retrieve a list of Add-ons currently installed on this Account. + description: Retrieve a list of all Deployments belonging to the Fleet. tags: - - PreviewMarketplaceInstalledAddOn + - 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 @@ -5499,12 +2223,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnResponse + title: ListDeployedDevicesDeploymentResponse properties: - installed_add_ons: + deployments: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on' + $ref: '#/components/schemas/preview.deployed_devices.fleet.deployment' meta: properties: first_page_url: @@ -5529,318 +2253,293 @@ paths: type: string type: object examples: - readFull: + readEmpty: value: - installed_add_ons: - - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployments: [] meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 - next_page_url: null - key: installed_add_ons - readEmpty: + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + readFull: value: - installed_add_ons: [] + deployments: + - sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sync_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments/DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 + key: deployments + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 - next_page_url: null - key: installed_add_ons - description: OK - security: - - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOn - /marketplace/InstalledAddOns/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - extensions: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions - usage: - mapping: - installed_add_on_sid: sid - resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage - pathType: instance - 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 - 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' - examples: - fetch: - value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK - security: - - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOn - 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' - examples: - update: - value: - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: VoiceBase High Accuracy Transcription - description: Automatic Transcription and Keyword Extract... - configuration: - bad_words: true - unique_name: voicebase_high_accuracy_transcription_2 - date_created: '2016-04-07T23:52:28Z' - date_updated: '2016-04-07T23:52:28Z' - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - links: - extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions - available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOn - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateMarketplaceInstalledAddOnRequest - properties: - Configuration: - description: Valid JSON object that conform to the configuration - schema exposed by the associated AvailableAddOn resource. This - is only required by Add-ons that need to be configured - UniqueName: - type: string - description: An application-defined string that uniquely identifies - the resource. This value must be unique within the Account. - examples: - update: - value: - Configuration: '{"bad_words": true}' - UniqueName: voicebase_high_accuracy_transcription_2 - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: + operationId: ListDeployedDevicesDeployment + /DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension + parent: /Fleets/{Sid} pathType: instance get: - description: Fetch an instance of an Extension for the Installed Add-on. + description: Fetch information about a specific Device in the Fleet. tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDevice parameters: - - name: InstalledAddOnSid + - name: FleetSid 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}$ required: true - name: Sid in: path - description: The SID of the InstalledAddOn Extension resource to fetch. + description: Provides a 34 character string that uniquely identifies the requested + Device resource. 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' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' examples: fetch: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa enabled: true - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchMarketplaceInstalledAddOnExtension + operationId: FetchDeployedDevicesDevice + delete: + description: Delete a specific Device from the Fleet, also removing it from + associated Deployments. + tags: + - PreviewDeployedDevicesDevice + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + - name: Sid + in: path + description: Provides a 34 character string that uniquely identifies the requested + Device resource. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteDeployedDevicesDevice post: - description: Update an Extension for an Add-on installation. + 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: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDevice parameters: - - name: InstalledAddOnSid + - name: FleetSid 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}$ required: true - name: Sid in: path - description: The SID of the InstalledAddOn Extension resource to update. + description: Provides a 34 character string that uniquely identifies the requested + Device resource. 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' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' examples: update: value: - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - enabled: false - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateMarketplaceInstalledAddOnExtension + operationId: UpdateDeployedDevicesDevice requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateMarketplaceInstalledAddOnExtensionRequest + 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: Whether the Extension should be invoked. - required: - - Enabled + description: '' examples: update: value: - Enabled: false - /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + FriendlyName: friendly_name + Identity: identity + /DeployedDevices/Fleets/{FleetSid}/Devices: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /InstalledAddOns/{Sid} - className: installed_add_on_extension + parent: /Fleets/{Sid} pathType: list + post: + description: Create a new Device in the Fleet, optionally giving it a unique + name, friendly name, and assigning to a Deployment and/or human identity. + 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' + examples: + create: + value: + sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesDevice + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesDeviceRequest + properties: + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this Device, to be used in addition to SID, up to 128 characters + long. + FriendlyName: + type: string + description: Provides a human readable descriptive text to be assigned + to this Device, up to 256 characters long. + Identity: + type: string + description: Provides an arbitrary string identifier representing + a human user to be associated with this Device, up to 256 characters + long. + DeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Specifies the unique string identifier of the Deployment + group that this Device is going to be associated with. + Enabled: + type: boolean + description: '' + examples: + create: + value: + FriendlyName: friendly_name + UniqueName: unique_name + Identity: identity get: - description: Retrieve a list of Extensions for the Installed Add-on. + description: Retrieve a list of all Devices belonging to the Fleet. tags: - - PreviewMarketplaceInstalledAddOnExtension + - PreviewDeployedDevicesDevice parameters: - - name: InstalledAddOnSid + - name: FleetSid in: path - description: The SID of the InstalledAddOn resource with the extensions to - read. + 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: ^XE[0-9a-fA-F]{32}$ - required: true + pattern: ^DL[0-9a-fA-F]{32}$ - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -5866,12 +2565,12 @@ paths: application/json: schema: type: object - title: ListMarketplaceInstalledAddOnExtensionResponse + title: ListDeployedDevicesDeviceResponse properties: - extensions: + devices: type: array items: - $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + $ref: '#/components/schemas/preview.deployed_devices.fleet.device' meta: properties: first_page_url: @@ -5896,70 +2595,77 @@ paths: type: string type: object examples: - readFull: + readEmpty: value: - extensions: - - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: Incoming Voice Call - product_name: Programmable Voice - unique_name: voice-incoming - enabled: true - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + devices: [] meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions - readEmpty: + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + readFull: value: - extensions: [] + devices: + - sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + enabled: true + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: bob@twilio.com + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + date_authenticated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices/THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 + key: devices + next_page_url: null page: 0 page_size: 50 - first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 - next_page_url: null - key: extensions + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListMarketplaceInstalledAddOnExtension - /Sync/Services/{ServiceSid}/Documents/{Sid}: + operationId: ListDeployedDevicesDevice + /DeployedDevices/Fleets/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - document_permissions: + devices: mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys pathType: instance get: - description: '' + description: Fetch information about a specific Fleet in your account. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesFleet parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -5968,43 +2674,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet' examples: fetch: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocument + operationId: FetchDeployedDevicesFleet delete: - description: '' + description: 'Delete a specific Fleet from your account, also destroys all nested + resources: Devices, Deployments, Certificates, Keys.' tags: - - PreviewSyncDocument + - PreviewDeployedDevicesFleet parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true @@ -6013,157 +2713,143 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncDocument + operationId: DeleteDeployedDevicesFleet post: - description: '' + description: Update the friendly name property of a specific Fleet in your account. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesFleet parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: Sid in: path - description: '' + description: Provides a 34 character string that uniquely identifies the requested + Fleet resource. schema: type: string required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet' examples: update: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocument + operationId: UpdateDeployedDevicesFleet requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentRequest + title: UpdateDeployedDevicesFleetRequest properties: - Data: - description: '' - required: - - Data + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. + DefaultDeploymentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^DL[0-9a-fA-F]{32}$ + description: Provides a string identifier of a Deployment that is + going to be used as a default one for this Fleet. examples: update: value: - Data: '{}' - UniqueName: unique_name - /Sync/Services/{ServiceSid}/Documents: + FriendlyName: friendly_name + DefaultDeploymentSid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /DeployedDevices/Fleets: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - document_permissions: + devices: mapping: - service_sid: service_sid - document_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions - parent: /Services/{Sid} + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Devices + deployments: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Deployments + certificates: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Certificates + keys: + mapping: + fleet_sid: sid + resource_url: /DeployedDevices/Fleets/{fleet_sid}/Keys pathType: list post: - description: '' + description: Create a new Fleet for scoping of deployed devices within your + account. tags: - - PreviewSyncDocument - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true + - PreviewDeployedDevicesFleet responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet' examples: create: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys description: Created security: - accountSid_authToken: [] - operationId: CreateSyncDocument + operationId: CreateDeployedDevicesFleet requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncDocumentRequest + title: CreateDeployedDevicesFleetRequest properties: - UniqueName: + FriendlyName: type: string - description: '' - Data: - description: '' + description: Provides a human readable descriptive text for this + Fleet, up to 256 characters long. examples: create: value: - Data: '{}' - UniqueName: unique_name + FriendlyName: friendly_name get: - description: '' + description: Retrieve a list of all Fleets belonging to your account. tags: - - PreviewSyncDocument + - PreviewDeployedDevicesFleet 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 @@ -6189,12 +2875,12 @@ paths: application/json: schema: type: object - title: ListSyncDocumentResponse + title: ListDeployedDevicesFleetResponse properties: - documents: + fleets: type: array items: - $ref: '#/components/schemas/preview.sync.service.document' + $ref: '#/components/schemas/preview.deployed_devices.fleet' meta: properties: first_page_url: @@ -6221,238 +2907,274 @@ paths: examples: readEmpty: value: - documents: [] + fleets: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 - key: documents + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 readFull: value: - documents: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleets: + - sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + default_deployment_sid: DLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + devices: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Devices + deployments: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Deployments + certificates: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificates + keys: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 - key: documents + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 + key: fleets next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocument - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: + operationId: ListDeployedDevicesFleet + /DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + parent: /Fleets/{Sid} pathType: instance get: - description: Fetch a specific Sync Document Permission. + description: Fetch information about a specific Key credential in the Fleet. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesKey parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: 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: 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.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' examples: fetch: value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncDocumentPermission + operationId: FetchDeployedDevicesKey delete: - description: Delete a specific Sync Document Permission. + description: Delete a specific Key credential from the Fleet, effectively disallowing + any inbound client connections that are presenting it. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesKey parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: 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: 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: DeleteSyncDocumentPermission + operationId: DeleteDeployedDevicesKey post: - description: Update an identity's access to a specific Sync Document. + description: Update the given properties of a specific Key credential in the + Fleet, giving it a friendly name or assigning to a Device. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesKey parameters: - - name: ServiceSid - in: path - description: The unique SID identifier of the Sync Service Instance. - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: DocumentSid + - name: FleetSid 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 human user associated - with an FPA token, assigned by the developer. + 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.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' examples: update: value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncDocumentPermission + operationId: UpdateDeployedDevicesKey requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncDocumentPermissionRequest + title: UpdateDeployedDevicesKeyRequest 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 + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. examples: update: value: - Read: 'true' - Write: 'true' - Manage: 'true' - /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name + /DeployedDevices/Fleets/{FleetSid}/Keys: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Documents/{Sid} - mountName: document_permissions + parent: /Fleets/{Sid} pathType: list + post: + description: Create a new Key credential in the Fleet, optionally giving it + a friendly name and assigning to a Device. + tags: + - PreviewDeployedDevicesKey + parameters: + - name: FleetSid + in: path + description: '' + schema: + type: string + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' + examples: + create: + value: + sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: null + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created + security: + - accountSid_authToken: [] + operationId: CreateDeployedDevicesKey + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateDeployedDevicesKeyRequest + properties: + FriendlyName: + type: string + description: Provides a human readable descriptive text for this + Key credential, up to 256 characters long. + DeviceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^TH[0-9a-fA-F]{32}$ + description: Provides the unique string identifier of an existing + Device to become authenticated with this Key credential. + examples: + create: + value: + DeviceSid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + FriendlyName: friendly_name get: - description: Retrieve a list of all Permissions applying to a Sync Document. + description: Retrieve a list of all Keys credentials belonging to the Fleet. tags: - - PreviewSyncDocumentPermission + - PreviewDeployedDevicesKey parameters: - - name: ServiceSid + - name: FleetSid in: path description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: DocumentSid - in: path - description: Identifier of the Sync Document. Either a SID or a unique name. + - name: DeviceSid + in: query + description: Filters the resulting list of Keys by a unique string identifier + of an authenticated Device. schema: type: string - required: true + 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 @@ -6478,12 +3200,12 @@ paths: application/json: schema: type: object - title: ListSyncDocumentPermissionResponse + title: ListDeployedDevicesKeyResponse properties: - permissions: + keys: type: array items: - $ref: '#/components/schemas/preview.sync.service.document.document_permission' + $ref: '#/components/schemas/preview.deployed_devices.fleet.key' meta: properties: first_page_url: @@ -6510,265 +3232,231 @@ paths: examples: readEmpty: value: - permissions: [] + keys: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 readFull: value: - permissions: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + keys: + - sid: KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: friendly_name + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + fleet_sid: FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + device_sid: THaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + secret: null + date_created: '2016-07-30T20:00:00Z' + date_updated: '2016-07-30T20:00:00Z' + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys/KYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 + key: keys next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/DeployedDevices/Fleets/FLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncDocumentPermission - /Sync/Services/{Sid}: + operationId: ListDeployedDevicesKey + /HostedNumbers/AuthorizationDocuments/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - sync_lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - sync_maps: + dependent_hosted_number_orders: mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders pathType: instance get: - description: '' + description: Fetch a specific AuthorizationDocument. tags: - - PreviewSyncService + - PreviewHostedNumbersAuthorizationDocument parameters: - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' examples: fetch: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name + address_sid: AD11111111111111111111111111111111 + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: false + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncService - 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 + operationId: FetchHostedNumbersAuthorizationDocument post: - description: '' + description: Updates a specific AuthorizationDocument. tags: - - PreviewSyncService + - PreviewHostedNumbersAuthorizationDocument parameters: - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this AuthorizationDocument. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' examples: update: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: true + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncService + operationId: UpdateHostedNumbersAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncServiceRequest + title: UpdateHostedNumbersAuthorizationDocumentRequest properties: - WebhookUrl: + 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 - format: uri - description: '' - FriendlyName: + 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: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' - examples: - update: - value: - FriendlyName: friendly_name - WebhookUrl: http://www.example.com - AclEnabled: true - /Sync/Services: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - documents: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Documents - sync_lists: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists - sync_maps: - mapping: - service_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps - pathType: list - post: - description: '' - tags: - - PreviewSyncService - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: true - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncService - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncServiceRequest - properties: - FriendlyName: + 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 - description: '' - WebhookUrl: + $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 - format: uri - description: '' - ReachabilityWebhooksEnabled: - type: boolean - description: '' - AclEnabled: - type: boolean - description: '' + description: The title of the person authorized to sign the Authorization + Document for this phone number. + ContactPhoneNumber: + type: string + description: The contact phone number of the person authorized to + sign the Authorization Document. examples: - create: + update: value: - FriendlyName: friendly_name - WebhookUrl: http://www.example.com - AclEnabled: true + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + Status: signing + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + dependent_hosted_number_orders: + mapping: + signing_document_sid: sid + resource_url: /HostedNumbers/AuthorizationDocuments/{signing_document_sid}/DependentHostedNumberOrders + pathType: list get: - description: '' + description: Retrieve a list of AuthorizationDocuments belonging to the account + initiating the request. tags: - - PreviewSyncService + - PreviewHostedNumbersAuthorizationDocument parameters: + - name: Email + in: query + description: Email that this AuthorizationDocument will be sent to for signing. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: test+hosted@twilio.com + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/authorization_document_enum_status' + examples: + readEmpty: + value: signed - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -6794,12 +3482,12 @@ paths: application/json: schema: type: object - title: ListSyncServiceResponse + title: ListHostedNumbersAuthorizationDocumentResponse properties: - services: + items: type: array items: - $ref: '#/components/schemas/preview.sync.service' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' meta: properties: first_page_url: @@ -6827,220 +3515,212 @@ paths: readEmpty: value: meta: - first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - key: services + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - services: [] + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0 + items: [] readFull: value: meta: - first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - key: services + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 - services: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - friendly_name: friendly_name + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0 + items: + - address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com links: - documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents - lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists - maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - webhook_url: http://www.example.com - reachability_webhooks_enabled: false - acl_enabled: false - description: OK - security: - - accountSid_authToken: [] - operationId: ListSyncService - /Sync/Services/{ServiceSid}/Lists/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - sync_list_items: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items - sync_list_permissions: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_lists - pathType: instance - get: - 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: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncList - 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 - /Sync/Services/{ServiceSid}/Lists: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - dependentProperties: - sync_list_items: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items - sync_list_permissions: - mapping: - service_sid: service_sid - list_sid: sid - resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_lists - pathType: list - post: - description: '' - tags: - - PreviewSyncSyncList - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true + operationId: ListHostedNumbersAuthorizationDocument + 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.sync.service.sync_list' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document' examples: create: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' + address_sid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + dependent_hosted_number_orders: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders + sid: PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + status: signing + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncList + operationId: CreateHostedNumbersAuthorizationDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncListRequest + title: CreateHostedNumbersAuthorizationDocumentRequest properties: - UniqueName: + HostedNumberOrderSids: + type: array + items: + type: string + description: A list of HostedNumberOrder sids that this AuthorizationDocument + will authorize for hosting phone number capabilities on Twilio's + platform. + AddressSid: type: string - description: '' + 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 examples: create: value: - UniqueName: unique_name + AddressSid: ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + HostedNumberOrderSids: + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01 + - HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02 + ContactTitle: Mr. + ContactPhoneNumber: '+14155555555' + /HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /AuthorizationDocuments/{Sid} + pathType: list get: - description: '' + description: Retrieve a list of dependent HostedNumberOrders belonging to the + AuthorizationDocument. tags: - - PreviewSyncSyncList + - PreviewHostedNumbersDependentHostedNumberOrder parameters: - - name: ServiceSid + - name: SigningDocumentSid in: path - description: '' + description: A 34 character string that uniquely identifies the LOA document + associated with this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^PX[0-9a-fA-F]{32}$ required: true + - name: Status + in: query + description: 'Status of an instance resource. It can hold one of the values: + 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section + entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) + for more information on each of these statuses.' + schema: + type: string + $ref: '#/components/schemas/dependent_hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. + schema: + type: string + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid + in: query + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ + examples: + readEmpty: + value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - name: FriendlyName + in: query + description: A human readable description of this resource, up to 64 characters. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: example + - name: UniqueName + in: query + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + examples: + readEmpty: + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7066,12 +3746,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListResponse + title: ListHostedNumbersDependentHostedNumberOrderResponse properties: - lists: + items: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list' + $ref: '#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order' meta: properties: first_page_url: @@ -7098,325 +3778,338 @@ paths: examples: readEmpty: value: - lists: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 - key: lists + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 + items: [] readFull: value: - lists: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 - key: lists + first_page_url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + failure_reason: '' + unique_name: foobar + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncList - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + operationId: ListHostedNumbersDependentHostedNumberOrder + /HostedNumbers/HostedNumberOrders/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items pathType: instance get: - description: '' + description: Fetch a specific HostedNumberOrder. tags: - - PreviewSyncSyncListItem + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - - name: Index - in: path - description: '' - schema: - type: integer + pattern: ^HR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '5105' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncListItem + operationId: FetchHostedNumbersHostedNumberOrder delete: - description: '' + description: Cancel the HostedNumberOrder (only available when the status is + in `received`). tags: - - PreviewSyncSyncListItem + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - - name: Index - in: path - description: '' - schema: - type: integer + pattern: ^HR[0-9a-fA-F]{32}$ required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncListItem + operationId: DeleteHostedNumbersHostedNumberOrder post: - description: '' + description: Updates a specific HostedNumberOrder. tags: - - PreviewSyncSyncListItem + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: A 34 character string that uniquely identifies this HostedNumberOrder. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' - schema: - type: string - required: true - - name: Index - in: path - description: '' - schema: - type: integer + pattern: ^HR[0-9a-fA-F]{32}$ required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - test1@twilio.com + - test2@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test+hosted@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: new friendly name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: pending-loa + unique_name: new unique name + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 1 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListItem + operationId: UpdateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListItemRequest + title: UpdateHostedNumbersHostedNumberOrderRequest properties: - Data: - description: '' - required: - - Data + FriendlyName: + type: string + description: A 64 character string that is a human readable text + that describes this resource. + UniqueName: + type: string + description: Provides a unique and addressable name to be assigned + to this HostedNumberOrder, assigned by the developer, to be optionally + used in addition to SID. + Email: + type: string + description: Email of the owner of this phone number that is being + hosted. + CcEmails: + type: array + items: + type: string + description: Optional. A list of emails that LOA document for this + HostedNumberOrder will be carbon copied to. + Status: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_status' + description: User can only post to `pending-verification` status + to transition the HostedNumberOrder to initiate a verification + call or verification of ownership with a copy of a phone bill. + VerificationCode: + type: string + description: A verification code that is given to the user via a + phone call to the phone number that is being hosted. + VerificationType: + type: string + $ref: '#/components/schemas/hosted_number_order_enum_verification_type' + description: Optional. The method used for verifying ownership of + the number to be hosted. One of phone-call (default) or phone-bill. + VerificationDocumentSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^RI[0-9a-fA-F]{32}$ + description: Optional. The unique sid identifier of the Identity + Document that represents the document for verifying ownership + of the number to be hosted. Required when VerificationType is + phone-bill. + Extension: + type: string + description: Digits to dial after connecting the verification call. + CallDelay: + type: integer + description: The number of seconds, between 0 and 60, to delay before + initiating the verification call. Defaults to 0. examples: update: value: - Data: '{}' - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: + FriendlyName: new friendly name + UniqueName: new unique name + Email: test+hosted@twilio.com + CcEmails: + - test1@twilio.com + - test2@twilio.com + Status: pending-loa + Extension: '1234' + CallDelay: 15 + /HostedNumbers/HostedNumberOrders: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_items pathType: list - 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' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 - description: Created - security: - - accountSid_authToken: [] - operationId: CreateSyncSyncListItem - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateSyncSyncListItemRequest - properties: - Data: - description: '' - required: - - Data - examples: - create: - value: - Data: '{}' get: - description: '' + description: Retrieve a list of HostedNumberOrders belonging to the account + initiating the request. tags: - - PreviewSyncSyncListItem + - PreviewHostedNumbersHostedNumberOrder parameters: - - name: ServiceSid - in: path - description: '' + - 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 - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: ListSid - in: path - description: '' + $ref: '#/components/schemas/hosted_number_order_enum_status' + examples: + readEmpty: + value: completed + - name: PhoneNumber + in: query + description: An E164 formatted phone number hosted by this HostedNumberOrder. schema: type: string - required: true - - name: Order + format: phone-number + examples: + readEmpty: + value: '+19193608000' + - name: IncomingPhoneNumberSid in: query - description: '' + description: A 34 character string that uniquely identifies the IncomingPhoneNumber + resource created by this HostedNumberOrder. schema: type: string - $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + minLength: 34 + maxLength: 34 + pattern: ^PN[0-9a-fA-F]{32}$ examples: readEmpty: - value: asc - readFull: - value: asc - - name: From + value: PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz + - name: FriendlyName in: query - description: '' + description: A human readable description of this resource, up to 64 characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: - value: from - readFull: - value: from - - name: Bounds + value: example + - name: UniqueName in: query - description: '' + description: Provides a unique and addressable name to be assigned to this + HostedNumberOrder, assigned by the developer, to be optionally used in addition + to SID. schema: type: string - $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: - value: inclusive - readFull: - value: inclusive + value: something123 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7442,12 +4135,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListItemResponse + title: ListHostedNumbersHostedNumberOrderResponse properties: items: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' meta: properties: first_page_url: @@ -7474,236 +4167,374 @@ paths: examples: readEmpty: value: - items: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?Status=completed&FriendlyName=example&PhoneNumber=%2B19193608000&UniqueName=something123&IncomingPhoneNumberSid=PNzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz&PageSize=50&Page=0 + items: [] readFull: value: - items: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - index: 100 - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 key: items next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0 + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: AD11111111111111111111111111111111 + call_delay: 15 + capabilities: + sms: true + voice: false + cc_emails: + - aaa@twilio.com + - bbb@twilio.com + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: '1234' + failure_reason: '' + friendly_name: friendly_name + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: PX11111111111111111111111111111111 + status: received + unique_name: foobar + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + - CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab + verification_code: '8794' + verification_document_sid: null + verification_type: phone-call description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListItem - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions - pathType: instance - get: - description: Fetch a specific Sync List Permission. + operationId: ListHostedNumbersHostedNumberOrder + post: + description: Host a phone number's capability on Twilio's platform. 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 + - PreviewHostedNumbersHostedNumberOrder responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.hosted_numbers.hosted_number_order' examples: - fetch: + create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncSyncListPermission - 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 - 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 - - name: ListSid - in: path - description: Identifier of the Sync List. Either a SID or a unique name. - schema: - type: string - required: true - - name: Identity - in: path - description: Arbitrary string identifier representing a human user associated - with an FPA token, assigned by the developer. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' - examples: - update: + address_sid: AD11111111111111111111111111111111 + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: test@twilio.com + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithoutOptionalLoaFields: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity - description: OK + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: null + verification_type: phone-call + createWithPhoneBillVerification: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + address_sid: null + call_delay: 0 + capabilities: + sms: true + voice: false + cc_emails: [] + date_created: '2017-03-28T20:06:39Z' + date_updated: '2017-03-28T20:06:39Z' + email: null + extension: null + failure_reason: '' + friendly_name: null + incoming_phone_number_sid: PN11111111111111111111111111111111 + phone_number: '+14153608311' + sid: HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + signing_document_sid: null + status: received + unique_name: null + url: https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_attempts: 0 + verification_call_sids: null + verification_code: null + verification_document_sid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verification_type: phone-bill + description: Created security: - accountSid_authToken: [] - operationId: UpdateSyncSyncListPermission + operationId: CreateHostedNumbersHostedNumberOrder requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncListPermissionRequest + title: CreateHostedNumbersHostedNumberOrderRequest 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: + 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: Boolean flag specifying whether the identity can delete - the Sync List. + 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: - - Read - - Write - - Manage + - PhoneNumber + - SmsCapability examples: - update: + create: value: - Read: 'true' - Write: 'true' - Manage: 'true' - /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: + AddressSid: AD11111111111111111111111111111111 + PhoneNumber: '+14153608311' + SmsCapability: true + Email: test@twilio.com + createWithoutOptionalLoaFields: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + createWithPhoneBillVerification: + value: + PhoneNumber: '+14153608311' + SmsCapability: true + VerificationType: phone-bill + VerificationDocumentSid: RIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /marketplace/AvailableAddOns/{Sid}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions + pathType: instance + get: + description: Fetch an instance of an Add-on currently available to be installed. + 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' + examples: + fetch: + value: + sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceAvailableAddOn + /marketplace/AvailableAddOns: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Lists/{Sid} - mountName: sync_list_permissions + dependentProperties: + extensions: + mapping: + available_add_on_sid: sid + resource_url: /marketplace/AvailableAddOns/{available_add_on_sid}/Extensions pathType: list get: - description: Retrieve a list of all Permissions applying to a Sync List. + description: Retrieve a list of Add-ons currently available to be installed. tags: - - PreviewSyncSyncListPermission + - PreviewMarketplaceAvailableAddOn 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 @@ -7729,12 +4560,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncListPermissionResponse + title: ListMarketplaceAvailableAddOnResponse properties: - permissions: + available_add_ons: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' + $ref: '#/components/schemas/preview.marketplace.available_add_on' meta: properties: first_page_url: @@ -7759,218 +4590,293 @@ paths: type: string type: object examples: - readEmpty: + readFull: value: - permissions: [] + available_add_ons: + - sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + pricing_type: per minute + configuration_schema: + type: object + properties: + bad_words: + type: boolean + required: + - bad_words + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 - readFull: + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons + readEmpty: value: - permissions: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + available_add_ons: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/marketplace/AvailableAddOns?PageSize=50&Page=0 + next_page_url: null + key: available_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncListPermission - /Sync/Services/{ServiceSid}/Maps/{Sid}: + operationId: ListMarketplaceAvailableAddOn + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - dependentProperties: - sync_map_items: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items - sync_map_permissions: - mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_maps + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension pathType: instance get: - description: '' + description: Fetch an instance of an Extension for the Available Add-on. tags: - - PreviewSyncSyncMap + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: ServiceSid + - name: AvailableAddOnSid in: path - description: '' + description: The SID of the AvailableAddOn resource with the extension to + fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: '' + 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.sync.service.sync_map' + $ref: '#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension' examples: fetch: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMap - delete: - description: '' + operationId: FetchMarketplaceAvailableAddOnExtension + /marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /AvailableAddOns/{Sid} + className: available_add_on_extension + pathType: list + get: + description: Retrieve a list of Extensions for the Available Add-on. tags: - - PreviewSyncSyncMap + - PreviewMarketplaceAvailableAddOnExtension parameters: - - name: ServiceSid + - name: AvailableAddOnSid in: path - description: '' + description: The SID of the AvailableAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XB[0-9a-fA-F]{32}$ required: true - - name: Sid - in: path - description: '' + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. schema: type: string - required: true responses: - '204': - description: The resource was deleted successfully. + '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: + properties: + first_page_url: + format: uri + type: string + key: + type: string + next_page_url: + format: uri + nullable: true + type: string + page: + type: integer + page_size: + type: integer + previous_page_url: + format: uri + nullable: true + type: string + url: + format: uri + type: string + type: object + examples: + readFull: + value: + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + available_add_on_sid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: + value: + extensions: [] + meta: + page: 0 + page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + previous_page_url: null + url: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + description: OK security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMap - /Sync/Services/{ServiceSid}/Maps: + operationId: ListMarketplaceAvailableAddOnExtension + /marketplace/InstalledAddOns: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - sync_map_items: + extensions: mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items - sync_map_permissions: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: mapping: - service_sid: service_sid - map_sid: sid - resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions - parent: /Services/{Sid} - mountName: sync_maps + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage pathType: list post: - description: '' + description: Install an Add-on for the Account specified. tags: - - PreviewSyncSyncMap - parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true + - PreviewMarketplaceInstalledAddOn responses: '201': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' examples: create: value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_1 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Created security: - accountSid_authToken: [] - operationId: CreateSyncSyncMap + operationId: CreateMarketplaceInstalledAddOn requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapRequest + title: CreateMarketplaceInstalledAddOnRequest properties: + AvailableAddOnSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XB[0-9a-fA-F]{32}$ + description: The SID of the AvaliableAddOn to install. + AcceptTermsOfService: + type: boolean + description: Whether the Terms of Service were accepted. + Configuration: + description: The JSON object that represents the configuration of + the new Add-on being installed. UniqueName: type: string - description: '' + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. + required: + - AvailableAddOnSid + - AcceptTermsOfService examples: create: value: - UniqueName: unique_name + AvailableAddOnSid: XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + AcceptTermsOfService: true + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_1 get: - description: '' + description: Retrieve a list of Add-ons currently installed on this Account. tags: - - PreviewSyncSyncMap + - PreviewMarketplaceInstalledAddOn parameters: - - name: ServiceSid - in: path - description: '' - schema: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -7996,12 +4902,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapResponse + title: ListMarketplaceInstalledAddOnResponse properties: - maps: + installed_add_ons: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map' + $ref: '#/components/schemas/preview.marketplace.installed_add_on' meta: properties: first_page_url: @@ -8026,332 +4932,318 @@ paths: type: string type: object examples: - readEmpty: + readFull: value: - maps: [] + installed_add_ons: + - sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 - key: maps - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 - readFull: + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons + readEmpty: value: - maps: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - links: - items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items - permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_ons: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 - key: maps - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + url: https://preview.twilio.com/marketplace/InstalledAddOns?PageSize=50&Page=0 + next_page_url: null + key: installed_add_ons description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMap - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + operationId: ListMarketplaceInstalledAddOn + /marketplace/InstalledAddOns/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items - pathType: instance - 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' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key - description: OK - security: - - accountSid_authToken: [] - operationId: FetchSyncSyncMapItem - 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 + dependentProperties: + extensions: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Extensions + usage: + mapping: + installed_add_on_sid: sid + resource_url: /marketplace/InstalledAddOns/{installed_add_on_sid}/Usage + pathType: instance + delete: + description: Remove an Add-on installation from your account + tags: + - PreviewMarketplaceInstalledAddOn + parameters: + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn resource to delete. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: If-Match - in: header - description: The If-Match HTTP request header - schema: - type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapItem - post: - description: '' + operationId: DeleteMarketplaceInstalledAddOn + get: + description: Fetch an instance of an Add-on currently installed on this Account. tags: - - PreviewSyncSyncMapItem + - PreviewMarketplaceInstalledAddOn parameters: - - name: ServiceSid + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn resource to fetch. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: Key + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on' + examples: + fetch: + value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceInstalledAddOn + post: + description: Update an Add-on installation for the Account specified. + tags: + - PreviewMarketplaceInstalledAddOn + parameters: + - name: Sid in: path - description: '' + 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 - - 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.marketplace.installed_add_on' examples: update: value: + sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + friendly_name: VoiceBase High Accuracy Transcription + description: Automatic Transcription and Keyword Extract... + configuration: + bad_words: true + unique_name: voicebase_high_accuracy_transcription_2 + date_created: '2016-04-07T23:52:28Z' + date_updated: '2016-04-07T23:52:28Z' + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + extensions: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions + available_add_on: https://preview.twilio.com/marketplace/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapItem + operationId: UpdateMarketplaceInstalledAddOn requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapItemRequest + title: UpdateMarketplaceInstalledAddOnRequest properties: - Data: - description: '' - required: - - Data + Configuration: + description: Valid JSON object that conform to the configuration + schema exposed by the associated AvailableAddOn resource. This + is only required by Add-ons that need to be configured + UniqueName: + type: string + description: An application-defined string that uniquely identifies + the resource. This value must be unique within the Account. examples: update: value: - Data: '{}' - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + Configuration: '{"bad_words": true}' + UniqueName: voicebase_high_accuracy_transcription_2 + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_items - pathType: list + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + pathType: instance + get: + description: Fetch an instance of an Extension for the Installed Add-on. + tags: + - PreviewMarketplaceInstalledAddOnExtension + parameters: + - name: InstalledAddOnSid + in: path + description: The SID of the InstalledAddOn resource with the extension to + fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XE[0-9a-fA-F]{32}$ + required: true + - name: Sid + in: path + description: The SID of the InstalledAddOn Extension resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' + examples: + fetch: + value: + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK + security: + - accountSid_authToken: [] + operationId: FetchMarketplaceInstalledAddOnExtension post: - description: '' + description: Update an Extension for an Add-on installation. tags: - - PreviewSyncSyncMapItem + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: ServiceSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extension to + update. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path - description: '' + description: The SID of the InstalledAddOn Extension resource to update. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^XF[0-9a-fA-F]{32}$ required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' examples: - create: + update: value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key - description: Created + sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: false + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: OK security: - accountSid_authToken: [] - operationId: CreateSyncSyncMapItem + operationId: UpdateMarketplaceInstalledAddOnExtension requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateSyncSyncMapItemRequest + title: UpdateMarketplaceInstalledAddOnExtensionRequest properties: - Key: - type: string - description: '' - Data: - description: '' + Enabled: + type: boolean + description: Whether the Extension should be invoked. required: - - Key - - Data + - Enabled examples: - create: + update: value: - Data: '{}' - Key: key + Enabled: false + /marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /InstalledAddOns/{Sid} + className: installed_add_on_extension + pathType: list get: - description: '' + description: Retrieve a list of Extensions for the Installed Add-on. tags: - - PreviewSyncSyncMapItem + - PreviewMarketplaceInstalledAddOnExtension parameters: - - name: ServiceSid + - name: InstalledAddOnSid in: path - description: '' + description: The SID of the InstalledAddOn resource with the extensions to + read. schema: type: string minLength: 34 maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - required: true - - name: MapSid - in: path - description: '' - schema: - type: string + pattern: ^XE[0-9a-fA-F]{32}$ required: true - - name: Order - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_result_order' - examples: - readEmpty: - value: asc - readFull: - value: asc - - name: From - in: query - description: '' - schema: - type: string - examples: - readEmpty: - value: from - readFull: - value: from - - name: Bounds - in: query - description: '' - schema: - type: string - $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' - examples: - readEmpty: - value: inclusive - readFull: - value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8377,12 +5269,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapItemResponse + title: ListMarketplaceInstalledAddOnExtensionResponse properties: - items: + extensions: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' + $ref: '#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension' meta: properties: first_page_url: @@ -8407,55 +5299,57 @@ paths: type: string type: object examples: - readEmpty: + readFull: value: - items: [] + extensions: + - sid: XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + installed_add_on_sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + friendly_name: Incoming Voice Call + product_name: Programmable Voice + unique_name: voice-incoming + enabled: true + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions/XFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 - key: items - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 - readFull: + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions + readEmpty: value: - items: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - created_by: created_by - data: {} - date_created: '2015-07-30T20:00:00Z' - date_updated: '2015-07-30T20:00:00Z' - key: key - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - revision: revision - service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + extensions: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 - key: items - next_page_url: null page: 0 page_size: 50 + first_page_url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + url: https://preview.twilio.com/marketplace/InstalledAddOns/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions?PageSize=50&Page=0 + next_page_url: null + key: extensions description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapItem - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + operationId: ListMarketplaceInstalledAddOnExtension + /Sync/Services/{ServiceSid}/Documents/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions + 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 get: - description: Fetch a specific Sync Map Permission. + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -8466,16 +5360,9 @@ 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: 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 @@ -8484,26 +5371,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.document' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] - operationId: FetchSyncSyncMapPermission + operationId: FetchSyncDocument delete: - description: Delete a specific Sync Map Permission. + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -8514,16 +5405,9 @@ 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: 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 @@ -8532,97 +5416,147 @@ paths: description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: DeleteSyncSyncMapPermission + operationId: DeleteSyncDocument post: - description: Update an identity's access to a specific Sync Map. + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewSyncDocument parameters: - name: ServiceSid in: path - description: The unique SID identifier of the Sync Service Instance. + description: '' schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: MapSid + - name: Sid in: path - description: Identifier of the Sync Map. Either a SID or a unique name. + description: '' 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. + - name: If-Match + in: header + description: The If-Match HTTP request header schema: type: string - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.document' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions description: OK security: - accountSid_authToken: [] - operationId: UpdateSyncSyncMapPermission + operationId: UpdateSyncDocument + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncDocumentRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + UniqueName: unique_name + /Sync/Services/{ServiceSid}/Documents: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + document_permissions: + mapping: + service_sid: service_sid + document_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents/{document_sid}/Permissions + parent: /Services/{Sid} + pathType: list + post: + description: '' + tags: + - PreviewSyncDocument + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.document' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + description: Created + security: + - accountSid_authToken: [] + operationId: CreateSyncDocument requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateSyncSyncMapPermissionRequest + title: CreateSyncDocumentRequest 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 + UniqueName: + type: string + description: '' + Data: + description: '' examples: - update: + create: value: - Read: 'true' - Write: 'true' - Manage: 'true' - /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Services/{ServiceSid}/Maps/{Sid} - mountName: sync_map_permissions - pathType: list + Data: '{}' + UniqueName: unique_name get: - description: Retrieve a list of all Permissions applying to a Sync Map. + description: '' tags: - - PreviewSyncSyncMapPermission + - PreviewSyncDocument parameters: - name: ServiceSid in: path @@ -8633,12 +5567,6 @@ 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 @@ -8664,12 +5592,12 @@ paths: application/json: schema: type: object - title: ListSyncSyncMapPermissionResponse + title: ListSyncDocumentResponse properties: - permissions: + documents: type: array items: - $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' + $ref: '#/components/schemas/preview.sync.service.document' meta: properties: first_page_url: @@ -8696,86 +5624,75 @@ paths: examples: readEmpty: value: - permissions: [] + documents: [] meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 readFull: value: - permissions: + documents: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + revision: revision service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - identity: identity - read: true - write: true - manage: true - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + links: + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions meta: - first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 - key: permissions + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 + key: documents next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListSyncSyncMapPermission - /understand/Assistants/{Sid}: + operationId: ListSyncDocument + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - 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 + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: instance get: - description: '' + description: Fetch a specific Sync Document Permission. tags: - - PreviewUnderstandAssistant + - PreviewSyncDocumentPermission parameters: - - name: Sid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity in: path - description: A 34 character string that uniquely identifies this resource. + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true @@ -8784,42 +5701,79 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistant + operationId: FetchSyncDocumentPermission + delete: + description: Delete a specific Sync Document Permission. + tags: + - PreviewSyncDocumentPermission + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity + in: path + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. + schema: + type: string + required: true + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncDocumentPermission post: - description: '' + description: Update an identity's access to a specific Sync Document. tags: - - PreviewUnderstandAssistant + - PreviewSyncDocumentPermission parameters: - - name: Sid + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true + - name: Identity in: path - description: A 34 character string that uniquely identifies this resource. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string required: true @@ -8828,146 +5782,80 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistant + operationId: UpdateSyncDocumentPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantRequest + title: UpdateSyncDocumentPermissionRequest properties: - FriendlyName: - type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: + Read: type: boolean - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: - type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant + description: Boolean flag specifying whether the identity can read + the Sync Document. + Write: + type: boolean + description: Boolean flag specifying whether the identity can update + the Sync Document. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Document. + required: + - Read + - Write + - Manage examples: update: value: - FriendlyName: so so friendly - UniqueName: so-so-unique - LogQueries: true - CallbackUrl: https://example.com/callback_url - CallbackEvents: model_build_completed model_build_failed - FallbackActions: '{"actions":[{}]}' - InitiationActions: '{"actions":[{}]}' - StyleSheet: '{}' - delete: - description: '' - 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 - /understand/Assistants: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - 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 + parent: /Services/{ServiceSid}/Documents/{Sid} + mountName: document_permissions pathType: list get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync Document. tags: - - PreviewUnderstandAssistant + - PreviewSyncDocumentPermission parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: DocumentSid + in: path + description: Identifier of the Sync Document. Either a SID or a unique name. + schema: + type: string + required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -8993,12 +5881,12 @@ paths: application/json: schema: type: object - title: ListUnderstandAssistantResponse + title: ListSyncDocumentPermissionResponse properties: - assistants: + permissions: type: array items: - $ref: '#/components/schemas/preview.understand.assistant' + $ref: '#/components/schemas/preview.sync.service.document.document_permission' meta: properties: first_page_url: @@ -9025,453 +5913,265 @@ paths: examples: readEmpty: value: - assistants: [] + permissions: [] meta: - first_page_url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 - key: assistants + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: - assistants: + permissions: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + document_sid: ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - first_page_url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 - key: assistants + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null page: 0 page_size: 50 previous_page_url: null - url: https://preview.twilio.com/understand/Assistants?PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandAssistant - post: - description: '' - tags: - - PreviewUnderstandAssistant - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2017-07-04T08:34:00Z' - date_updated: '2017-07-04T08:34:00Z' - friendly_name: so so friendly - latest_model_build_sid: null - log_queries: true - sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: so-so-unique - links: - field_types: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes - tasks: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks - model_builds: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds - queries: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries - assistant_fallback_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - assistant_initiation_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - dialogues: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues - style_sheet: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - callback_url: https://example.com/callback_url - callback_events: model_build_completed model_build_failed - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandAssistant - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandAssistantRequest - properties: - FriendlyName: - type: string - description: A text description for the Assistant. It is non-unique - and can up to 255 characters long. - LogQueries: - type: boolean - description: A boolean that specifies whether queries should be - logged for 30 days further training. If false, no queries will - be stored, if true, queries will be stored for 30 days and deleted - thereafter. Defaults to true if no value is provided. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - CallbackUrl: - type: string - format: uri - description: A user-provided URL to send event callbacks to. - CallbackEvents: - type: string - description: Space-separated list of callback events that will trigger - callbacks. - FallbackActions: - description: The JSON actions to be executed when the user's input - is not recognized as matching any Task. - InitiationActions: - description: The JSON actions to be executed on inbound phone calls - when the Assistant has to say something first. - StyleSheet: - description: The JSON object that holds the style sheet for the - assistant - examples: - create: - value: - FriendlyName: so so friendly - UniqueName: so-so-unique - LogQueries: true - CallbackUrl: https://example.com/callback_url - CallbackEvents: model_build_completed model_build_failed - FallbackActions: '{"actions":[{}]}' - InitiationActions: '{"actions":[{}]}' - StyleSheet: '{}' - /understand/Assistants/{AssistantSid}/FallbackActions: + operationId: ListSyncDocumentPermission + /Sync/Services/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Assistants/{Sid} - mountName: assistant_fallback_actions - className: assistant_fallback_actions + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps pathType: instance get: description: '' tags: - - PreviewUnderstandAssistantFallbackActions + - PreviewSyncService parameters: - - name: AssistantSid + - 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.understand.assistant.assistant_fallback_actions' + $ref: '#/components/schemas/preview.sync.service' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandAssistantFallbackActions - post: - description: '' - tags: - - PreviewUnderstandAssistantFallbackActions - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.assistant_fallback_actions' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FallbackActions - data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantFallbackActions - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandAssistantFallbackActionsRequest - properties: - FallbackActions: - description: '' - examples: - update: - value: - FallbackActions: '{"actions":[{}]}' - /understand/Assistants/{AssistantSid}/InitiationActions: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{Sid} - mountName: assistant_initiation_actions - className: assistant_initiation_actions - pathType: instance - get: + operationId: FetchSyncService + delete: description: '' tags: - - PreviewUnderstandAssistantInitiationActions + - PreviewSyncService parameters: - - name: AssistantSid + - 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.understand.assistant.assistant_initiation_actions' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - data: {} - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchUnderstandAssistantInitiationActions + operationId: DeleteSyncService post: description: '' tags: - - PreviewUnderstandAssistantInitiationActions + - PreviewSyncService parameters: - - name: AssistantSid + - 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.understand.assistant.assistant_initiation_actions' + $ref: '#/components/schemas/preview.sync.service' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/InitiationActions - data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandAssistantInitiationActions + operationId: UpdateSyncService requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandAssistantInitiationActionsRequest + title: UpdateSyncServiceRequest properties: - InitiationActions: + WebhookUrl: + type: string + format: uri + description: '' + FriendlyName: + type: string + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean description: '' examples: update: value: - InitiationActions: '{"actions":[{}]}' - /understand/Assistants/{AssistantSid}/Dialogues/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{Sid} - pathType: instance - get: - description: '' - tags: - - PreviewUnderstandDialogue - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.dialogue' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Dialogues/UKkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandDialogue - /understand/Assistants/{AssistantSid}/Dialogues: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true + /Sync/Services: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Assistants/{Sid} + dependentProperties: + documents: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Documents + sync_lists: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists + sync_maps: + mapping: + service_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps pathType: list - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: instance - get: + post: 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 + - PreviewSyncService responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.sync.service' examples: - fetch: + create: value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandField - 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. + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: true + description: Created security: - accountSid_authToken: [] - operationId: DeleteUnderstandField - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: list + operationId: CreateSyncService + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncServiceRequest + properties: + FriendlyName: + type: string + description: '' + WebhookUrl: + type: string + format: uri + description: '' + ReachabilityWebhooksEnabled: + type: boolean + description: '' + AclEnabled: + type: boolean + description: '' + examples: + create: + value: + FriendlyName: friendly_name + WebhookUrl: http://www.example.com + AclEnabled: true get: description: '' tags: - - PreviewUnderstandField + - PreviewSyncService parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Field. - schema: - type: string - required: true - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -9497,12 +6197,12 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldResponse + title: ListSyncServiceResponse properties: - fields: + services: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.field' + $ref: '#/components/schemas/preview.sync.service' meta: properties: first_page_url: @@ -9529,127 +6229,76 @@ paths: examples: readEmpty: value: - fields: [] meta: - page: 0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - key: fields + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services next_page_url: null - previous_page_url: null + page: 0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: [] readFull: value: - fields: - - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type meta: - page: 0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields?PageSize=50&Page=0 - key: fields + first_page_url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + key: services next_page_url: null - previous_page_url: null + page: 0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services?PageSize=50&Page=0 + services: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + friendly_name: friendly_name + links: + documents: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents + lists: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists + maps: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps + sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + webhook_url: http://www.example.com + reachability_webhooks_enabled: false + acl_enabled: false description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandField - 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' - examples: - create: - value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields/UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type: field_type - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandField - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandFieldRequest - properties: - FieldType: - type: string - description: The unique name or sid of the FieldType. It can be - any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) - or the unique_name or the Field Type sid of a custom Field Type. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - required: - - FieldType - - UniqueName - examples: - create: - value: - UniqueName: unique_name - FieldType: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}: + operationId: ListSyncService + /Sync/Services/{ServiceSid}/Lists/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] dependentProperties: - field_values: + 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: - assistant_sid: assistant_sid - field_type_sid: sid - resource_url: /understand/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues - parent: /Assistants/{Sid} + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists pathType: instance get: description: '' tags: - - PreviewUnderstandFieldType + - PreviewSyncSyncList parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -9662,34 +6311,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.sync.service.sync_list' examples: fetch: value: - unique_name: unique_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' links: - field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldType - post: + operationId: FetchSyncSyncList + delete: description: '' tags: - - PreviewUnderstandFieldType + - PreviewSyncSyncList parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path @@ -9698,96 +6352,97 @@ paths: type: string required: true responses: - '200': + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncList + /Sync/Services/{ServiceSid}/Lists: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + sync_list_items: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Items + sync_list_permissions: + mapping: + service_sid: service_sid + list_sid: sid + resource_url: /Sync/Services/{service_sid}/Lists/{list_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_lists + pathType: list + post: + description: '' + tags: + - PreviewSyncSyncList + parameters: + - name: ServiceSid + in: path + description: '' + 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.understand.assistant.field_type' + $ref: '#/components/schemas/preview.sync.service.sync_list' examples: - update: + create: value: - unique_name: unique_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' links: - field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: OK + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandFieldType + operationId: CreateSyncSyncList requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandFieldTypeRequest + title: CreateSyncSyncListRequest properties: - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. UniqueName: type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. + description: '' examples: - update: + create: value: UniqueName: unique_name - FriendlyName: friendly_name - 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 - /understand/Assistants/{AssistantSid}/FieldTypes: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - 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} - pathType: list get: description: '' tags: - - PreviewUnderstandFieldType + - PreviewSyncSyncList parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query @@ -9814,12 +6469,12 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldTypeResponse + title: ListSyncSyncListResponse properties: - field_types: + lists: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.sync.service.sync_list' meta: properties: first_page_url: @@ -9846,215 +6501,325 @@ paths: examples: readEmpty: value: + lists: [] meta: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - previous_page_url: null + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null page: 0 page_size: 50 - next_page_url: null - key: field_types - field_types: [] + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 readFull: value: - meta: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes?PageSize=50&Page=0 - previous_page_url: null - page: 0 - page_size: 50 - next_page_url: null - key: field_types - field_types: - - unique_name: unique_name - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + lists: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' links: - field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + meta: + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + key: lists + next_page_url: null + page: 0 + page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists?PageSize=50&Page=0 + description: OK + security: + - accountSid_authToken: [] + operationId: ListSyncSyncList + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items + pathType: instance + get: + description: '' + tags: + - PreviewSyncSyncListItem + parameters: + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: '' + schema: + type: string + required: true + - name: Index + in: path + description: '' + schema: + type: integer + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' + examples: + fetch: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldType + operationId: FetchSyncSyncListItem + 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 post: description: '' tags: - - PreviewUnderstandFieldType + - PreviewSyncSyncListItem parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid in: path description: '' 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' examples: - create: + update: value: - unique_name: unique_name account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_updated: '2015-07-30T20:00:00Z' - links: - field_values: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues - sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - description: Created + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandFieldType + operationId: UpdateSyncSyncListItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: CreateUnderstandFieldTypeRequest + title: UpdateSyncSyncListItemRequest 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. + Data: + description: '' required: - - UniqueName + - Data examples: - create: + update: value: - UniqueName: unique_name - FriendlyName: friendly_name - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: + Data: '{}' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Items: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - pathType: instance - get: + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_items + pathType: list + post: description: '' tags: - - PreviewUnderstandFieldValue + - PreviewSyncSyncListItem parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: FieldTypeSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: ListSid in: path description: '' schema: type: string required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' examples: - fetch: + create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: null - description: OK + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 + description: Created security: - accountSid_authToken: [] - operationId: FetchUnderstandFieldValue - delete: + operationId: CreateSyncSyncListItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncSyncListItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + create: + value: + Data: '{}' + get: description: '' tags: - - PreviewUnderstandFieldValue + - PreviewSyncSyncListItem parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: FieldTypeSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: ListSid in: path description: '' schema: type: string required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandFieldValue - /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} - pathType: list - get: - description: '' - tags: - - PreviewUnderstandFieldValue - parameters: - - name: AssistantSid - in: path + - name: Order + in: query description: '' schema: type: string - required: true - - name: FieldTypeSid - in: path + $ref: '#/components/schemas/sync_list_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From + in: query description: '' schema: type: string - required: true - - name: Language + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds in: query - description: 'An ISO language-country string of the value. For example: *en-US*' + description: '' schema: type: string + $ref: '#/components/schemas/sync_list_item_enum_query_from_bound_type' examples: readEmpty: - value: language + value: inclusive readFull: - value: language + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -10080,12 +6845,12 @@ paths: application/json: schema: type: object - title: ListUnderstandFieldValueResponse + title: ListSyncSyncListItemResponse properties: - field_values: + items: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_item' meta: properties: first_page_url: @@ -10112,170 +6877,154 @@ paths: examples: readEmpty: value: - field_values: [] + items: [] meta: - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 page_size: 50 previous_page_url: null - key: field_values - page: 0 - next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 readFull: value: - field_values: + items: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb + date_updated: '2015-07-30T20:00:00Z' + index: 100 + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100 meta: - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items + next_page_url: null + page: 0 page_size: 50 previous_page_url: null - key: field_values - page: 0 - next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues?Language=language&PageSize=50&Page=0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandFieldValue - post: - description: '' + operationId: ListSyncSyncListItem + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions + pathType: instance + get: + description: Fetch a specific Sync List Permission. tags: - - PreviewUnderstandFieldValue + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: FieldTypeSid + - name: ListSid in: path - description: '' + 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.understand.assistant.field_type.field_value' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' examples: - create: + fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldTypes/UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/FieldValues/UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - field_type_sid: UBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - language: language - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - value: value - date_updated: '2015-07-30T20:00:00Z' - date_created: '2015-07-30T20:00:00Z' - sid: UCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - synonym_of: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - description: Created + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandFieldValue - 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 - examples: - create: - value: - Value: value - Language: language - SynonymOf: UCbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{Sid} - pathType: instance - get: - description: '' + operationId: FetchSyncSyncListPermission + delete: + description: Delete a specific Sync List Permission. tags: - - PreviewUnderstandModelBuild + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true - - name: Sid + - name: Identity in: path - description: '' + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: enqueued - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: null - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchUnderstandModelBuild + operationId: DeleteSyncSyncListPermission post: - description: '' + description: Update an identity's access to a specific Sync List. tags: - - PreviewUnderstandModelBuild + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: '' + description: The unique SID identifier of the Sync Service Instance. schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: ListSid in: path - description: '' + 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 @@ -10284,79 +7033,77 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: completed - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: 100 - error_code: null + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandModelBuild + operationId: UpdateSyncSyncListPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandModelBuildRequest - properties: - UniqueName: - type: string - description: 'A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. For example: v0.1' + title: UpdateSyncSyncListPermissionRequest + properties: + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync List. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync List. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync List. + required: + - Read + - Write + - Manage examples: update: value: - UniqueName: unique_name - delete: - description: '' - tags: - - PreviewUnderstandModelBuild - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - - name: Sid - in: path - description: '' - schema: - type: string - required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandModelBuild - /understand/Assistants/{AssistantSid}/ModelBuilds: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Assistants/{Sid} + parent: /Services/{ServiceSid}/Lists/{Sid} + mountName: sync_list_permissions pathType: list get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync List. tags: - - PreviewUnderstandModelBuild + - PreviewSyncSyncListPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: ListSid + in: path + description: Identifier of the Sync List. Either a SID or a unique name. schema: type: string required: true @@ -10385,12 +7132,12 @@ paths: application/json: schema: type: object - title: ListUnderstandModelBuildResponse + title: ListSyncSyncListPermissionResponse properties: - model_builds: + permissions: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.model_build' + $ref: '#/components/schemas/preview.sync.service.sync_list.sync_list_permission' meta: properties: first_page_url: @@ -10417,117 +7164,75 @@ paths: examples: readEmpty: value: + permissions: [] meta: - page: 0 - key: model_builds - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null - previous_page_url: null + page: 0 page_size: 50 - model_builds: [] + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + list_sid: ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - page: 0 - key: model_builds - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds?PageSize=50&Page=0 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null - previous_page_url: null + page: 0 page_size: 50 - model_builds: - - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: failed - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: 23001 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandModelBuild - post: - description: '' - tags: - - PreviewUnderstandModelBuild - parameters: - - name: AssistantSid - in: path - description: '' - schema: - type: string - required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.model_build' - examples: - create: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ModelBuilds/UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - status: enqueued - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - unique_name: unique_name - build_duration: null - error_code: null - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandModelBuild - 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' - examples: - create: - value: - UniqueName: unique_name - StatusCallback: http://www.example.com - /understand/Assistants/{AssistantSid}/Queries/{Sid}: + operationId: ListSyncSyncListPermission + /Sync/Services/{ServiceSid}/Maps/{Sid}: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - parent: /Assistants/{Sid} + dependentProperties: + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps pathType: instance get: description: '' tags: - - PreviewUnderstandQuery + - PreviewSyncSyncMap parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true @@ -10536,182 +7241,139 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service.sync_map' examples: fetch: value: - language: language + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: - name: name - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - confidence: 0.9 - entities: - - name: name - value: value - type: type - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: voice + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandQuery - post: + operationId: FetchSyncSyncMap + delete: description: '' tags: - - PreviewUnderstandQuery + - PreviewSyncSyncMap parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the parent Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.query' - examples: - update: - value: - language: language - date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query - date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: - name: name - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - confidence: 0.9 - entities: - - name: name - value: value - type: type - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: sms - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: UpdateUnderstandQuery - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandQueryRequest - properties: - SampleSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ - description: An optional reference to the Sample created from this - query. - Status: - type: string - description: 'A string that described the query status. The values - can be: pending_review, reviewed, discarded' - examples: - update: - value: - Status: status - SampleSid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - delete: + operationId: DeleteSyncSyncMap + /Sync/Services/{ServiceSid}/Maps: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + dependentProperties: + sync_map_items: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Items + sync_map_permissions: + mapping: + service_sid: service_sid + map_sid: sid + resource_url: /Sync/Services/{service_sid}/Maps/{map_sid}/Permissions + parent: /Services/{Sid} + mountName: sync_maps + pathType: list + post: description: '' tags: - - PreviewUnderstandQuery + - PreviewSyncSyncMap parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: - '204': - description: The resource was deleted successfully. + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/preview.sync.service.sync_map' + examples: + create: + value: + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + date_created: '2015-07-30T20:00:00Z' + date_updated: '2015-07-30T20:00:00Z' + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + description: Created security: - accountSid_authToken: [] - operationId: DeleteUnderstandQuery - /understand/Assistants/{AssistantSid}/Queries: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{Sid} - pathType: list + operationId: CreateSyncSyncMap + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateSyncSyncMapRequest + properties: + UniqueName: + type: string + description: '' + examples: + create: + value: + UniqueName: unique_name get: description: '' tags: - - PreviewUnderstandQuery + - PreviewSyncSyncMap parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the parent Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Language - in: query - description: An ISO language-country string of the sample. - schema: - type: string - examples: - readEmpty: - value: language - readFull: - value: language - - name: ModelBuild - in: query - description: The Model Build Sid or unique name of the Model Build to be queried. - schema: - type: string - examples: - readEmpty: - value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - readFull: - value: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - - name: Status - in: query - description: 'A string that described the query status. The values can be: - pending_review, reviewed, discarded' - schema: - type: string - examples: - readEmpty: - value: status - readFull: - value: status - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -10737,12 +7399,12 @@ paths: application/json: schema: type: object - title: ListUnderstandQueryResponse + title: ListSyncSyncMapResponse properties: - queries: + maps: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service.sync_map' meta: properties: first_page_url: @@ -10769,333 +7431,330 @@ paths: examples: readEmpty: value: - queries: [] + maps: [] meta: - previous_page_url: null + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps next_page_url: null - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 page: 0 - key: queries - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 readFull: value: - queries: - - language: language + maps: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: - name: name - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - confidence: 0.9 - entities: - - name: name - value: value - type: type - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: null + links: + items: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items + permissions: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + unique_name: unique_name + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: - previous_page_url: null + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 + key: maps next_page_url: null - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 page: 0 - key: queries - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries?Status=status&ModelBuild=UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Language=language&PageSize=50&Page=0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandQuery - post: + operationId: ListSyncSyncMap + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + pathType: instance + get: description: '' tags: - - PreviewUnderstandQuery + - PreviewSyncSyncMapItem parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: '' + schema: + type: string + required: true + - name: Key in: path - description: The unique ID of the parent Assistant. + description: '' schema: type: string required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.query' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - create: + fetch: value: - language: language + account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - model_build_sid: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - query: query date_updated: '2015-07-30T20:00:00Z' - status: status - sample_sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - results: - task: - name: name - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - confidence: 0.9 - entities: - - name: name - value: value - type: type - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Queries/UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - source_channel: voice - description: Created + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + description: OK security: - accountSid_authToken: [] - operationId: CreateUnderstandQuery - 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 - examples: - create: - value: - Language: language - Query: query - Tasks: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,UDbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb - Field: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.UEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - ModelBuild: UGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: instance - get: + operationId: FetchSyncSyncMapItem + delete: description: '' tags: - - PreviewUnderstandSample + - PreviewSyncSyncMapItem parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: TaskSid + - name: MapSid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string required: true - - name: Sid + - name: Key + in: path + description: '' + schema: + type: string + required: true + - name: If-Match + in: header + description: The If-Match HTTP request header + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + security: + - accountSid_authToken: [] + operationId: DeleteSyncSyncMapItem + post: + description: '' + tags: + - PreviewSyncSyncMapItem + parameters: + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: 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.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - fetch: + update: value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text date_updated: '2015-07-30T20:00:00Z' - source_channel: null + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandSample + operationId: UpdateSyncSyncMapItem + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdateSyncSyncMapItemRequest + properties: + Data: + description: '' + required: + - Data + examples: + update: + value: + Data: '{}' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Items: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_items + pathType: list post: description: '' tags: - - PreviewUnderstandSample + - PreviewSyncSyncMapItem parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid + - name: ServiceSid in: path - description: The unique ID of the Task associated with this Sample. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: Sid + - name: MapSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string - minLength: 34 - maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' examples: - update: + create: value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text date_updated: '2015-07-30T20:00:00Z' - source_channel: alexa - description: OK + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key + description: Created security: - accountSid_authToken: [] - operationId: UpdateUnderstandSample + operationId: CreateSyncSyncMapItem requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandSampleRequest + title: CreateSyncSyncMapItemRequest 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: + Key: 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' + description: '' + Data: + description: '' + required: + - Key + - Data examples: - update: + create: value: - Language: language - TaggedText: tagged_text - delete: + Data: '{}' + Key: key + get: description: '' tags: - - PreviewUnderstandSample + - PreviewSyncSyncMapItem parameters: - - name: AssistantSid - in: path - description: The unique ID of the Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. - schema: - type: string - required: true - - name: Sid + - name: ServiceSid in: path - description: A 34 character string that uniquely identifies this resource. + description: '' schema: type: string minLength: 34 maxLength: 34 - pattern: ^UF[0-9a-fA-F]{32}$ + pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandSample - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - pathType: list - get: - description: '' - tags: - - PreviewUnderstandSample - parameters: - - name: AssistantSid + - name: MapSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string required: true - - name: TaskSid - in: path - description: The unique ID of the Task associated with this Sample. + - name: Order + in: query + description: '' schema: type: string - required: true - - name: Language + $ref: '#/components/schemas/sync_map_item_enum_query_result_order' + examples: + readEmpty: + value: asc + readFull: + value: asc + - name: From + in: query + description: '' + schema: + type: string + examples: + readEmpty: + value: from + readFull: + value: from + - name: Bounds in: query - description: An ISO language-country string of the sample. + description: '' schema: type: string + $ref: '#/components/schemas/sync_map_item_enum_query_from_bound_type' examples: readEmpty: - value: language + value: inclusive readFull: - value: language + value: inclusive - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -11121,12 +7780,12 @@ paths: application/json: schema: type: object - title: ListUnderstandSampleResponse + title: ListSyncSyncMapItemResponse properties: - samples: + items: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_item' meta: properties: first_page_url: @@ -11153,124 +7812,73 @@ paths: examples: readEmpty: value: - samples: [] + items: [] meta: - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - previous_page_url: null - key: samples + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 page: 0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 readFull: value: - samples: - - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + items: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + created_by: created_by + data: {} date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text date_updated: '2015-07-30T20:00:00Z' - source_channel: sms + key: key + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + revision: revision + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key meta: - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 - previous_page_url: null - key: samples + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 + key: items next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples?Language=language&PageSize=50&Page=0 page: 0 page_size: 50 + previous_page_url: null + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items?From=from&Bounds=inclusive&Order=asc&PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: ListUnderstandSample - post: - description: '' + operationId: ListSyncSyncMapItem + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}: + servers: + - url: https://preview.twilio.com + description: '' + x-twilio: + defaultOutputProperties: [] + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions + pathType: instance + get: + description: Fetch a specific Sync Map Permission. tags: - - PreviewUnderstandSample + - PreviewSyncSyncMapPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - - name: TaskSid + - name: MapSid in: path - description: The unique ID of the Task associated with this Sample. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.sample' - examples: - create: - value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples/UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - language: language - tagged_text: tagged_text - date_updated: '2015-07-30T20:00:00Z' - source_channel: alexa - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandSample - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandSampleRequest - properties: - Language: - type: string - description: An ISO language-country string of the sample. - TaggedText: - type: string - description: The text example of how end-users may express this - task. The sample may contain Field tag blocks. - SourceChannel: - type: string - description: 'The communication channel the sample was captured. - It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, - or *slack*. If not included the value will be null' - required: - - Language - - TaggedText - examples: - create: - value: - Language: language - TaggedText: tagged_text - SourceChannel: alexa - /understand/Assistants/{AssistantSid}/StyleSheet: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{Sid} - pathType: instance - get: - description: Returns Style sheet JSON object for this Assistant - tags: - - PreviewUnderstandStyleSheet - parameters: - - name: AssistantSid + - name: Identity in: path - description: The unique ID of the Assistant + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true @@ -11279,147 +7887,79 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - data: {} - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandStyleSheet - post: - description: Updates the style sheet for an assistant identified by {AssistantSid} - or {AssistantUniqueName}. + operationId: FetchSyncSyncMapPermission + delete: + description: Delete a specific Sync Map Permission. tags: - - PreviewUnderstandStyleSheet + - PreviewSyncSyncMapPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant + description: '' schema: type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.style_sheet' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/StyleSheet - data: {} - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandStyleSheet - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandStyleSheetRequest - properties: - StyleSheet: - description: The JSON Style sheet string - examples: - update: - value: - StyleSheet: '{}' - /understand/Assistants/{AssistantSid}/Tasks/{Sid}: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - 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} - pathType: instance - get: - description: '' - tags: - - PreviewUnderstandTask - parameters: - - name: AssistantSid + - name: MapSid in: path - description: The unique ID of the Assistant. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - - name: Sid + - name: Identity in: path - description: A 34 character string that uniquely identifies this resource. + description: Arbitrary string identifier representing a user associated with + an FPA token, assigned by the developer. schema: type: string required: true responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task' - examples: - fetch: - value: - unique_name: unique_name - links: - fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: OK + '204': + description: The resource was deleted successfully. security: - accountSid_authToken: [] - operationId: FetchUnderstandTask + operationId: DeleteSyncSyncMapPermission post: - description: '' + description: Update an identity's access to a specific Sync Map. tags: - - PreviewUnderstandTask + - PreviewSyncSyncMapPermission parameters: - - name: AssistantSid + - name: ServiceSid + in: path + description: The unique SID identifier of the Sync Service Instance. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid in: path - description: The unique ID of the Assistant. + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true - - name: Sid + - name: Identity in: path - description: A 34 character string that uniquely identifies this resource. + description: Arbitrary string identifier representing a human user associated + with an FPA token, assigned by the developer. schema: type: string required: true @@ -11428,119 +7968,77 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/preview.understand.assistant.task' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' examples: update: value: - unique_name: unique_name - links: - fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity description: OK security: - accountSid_authToken: [] - operationId: UpdateUnderstandTask + operationId: UpdateSyncSyncMapPermission requestBody: content: application/x-www-form-urlencoded: schema: type: object - title: UpdateUnderstandTaskRequest + title: UpdateSyncSyncMapPermissionRequest properties: - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions + Read: + type: boolean + description: Boolean flag specifying whether the identity can read + the Sync Map. + Write: + type: boolean + description: Boolean flag specifying whether the identity can create, + update and delete Items of the Sync Map. + Manage: + type: boolean + description: Boolean flag specifying whether the identity can delete + the Sync Map. + required: + - Read + - Write + - Manage examples: update: value: - FriendlyName: friendly_name - UniqueName: unique_name - Actions: '{"say":{"speech":"Your order is ready for pickup"}}' - ActionsUrl: https://example.com/actions_url - delete: - 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: - '204': - description: The resource was deleted successfully. - security: - - accountSid_authToken: [] - operationId: DeleteUnderstandTask - /understand/Assistants/{AssistantSid}/Tasks: + Read: 'true' + Write: 'true' + Manage: 'true' + /Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions: servers: - url: https://preview.twilio.com description: '' x-twilio: defaultOutputProperties: [] - 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} + parent: /Services/{ServiceSid}/Maps/{Sid} + mountName: sync_map_permissions pathType: list get: - description: '' + description: Retrieve a list of all Permissions applying to a Sync Map. tags: - - PreviewUnderstandTask + - PreviewSyncSyncMapPermission parameters: - - name: AssistantSid + - name: ServiceSid in: path - description: The unique ID of the Assistant. + description: '' + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + required: true + - name: MapSid + in: path + description: Identifier of the Sync Map. Either a SID or a unique name. schema: type: string required: true @@ -11569,12 +8067,12 @@ paths: application/json: schema: type: object - title: ListUnderstandTaskResponse + title: ListSyncSyncMapPermissionResponse properties: - tasks: + permissions: type: array items: - $ref: '#/components/schemas/preview.understand.assistant.task' + $ref: '#/components/schemas/preview.sync.service.sync_map.sync_map_permission' meta: properties: first_page_url: @@ -11601,254 +8099,38 @@ paths: examples: readEmpty: value: + permissions: [] meta: - key: tasks - page_size: 50 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 page: 0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page_size: 50 previous_page_url: null - tasks: [] + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 readFull: value: + permissions: + - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + map_sid: MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + identity: identity + read: true + write: true + manage: true + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity meta: - key: tasks - page_size: 50 + first_page_url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 + key: permissions next_page_url: null - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 page: 0 - first_page_url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks?PageSize=50&Page=0 + page_size: 50 previous_page_url: null - tasks: - - unique_name: unique_name - links: - fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: OK - security: - - accountSid_authToken: [] - operationId: ListUnderstandTask - 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' - examples: - create: - value: - unique_name: unique_name - links: - fields: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Fields - samples: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Samples - task_actions: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Actions - statistics: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - friendly_name: friendly_name - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_updated: '2015-07-30T20:00:00Z' - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - date_created: '2015-07-30T20:00:00Z' - actions_url: https://example.com/actions_url - description: Created - security: - - accountSid_authToken: [] - operationId: CreateUnderstandTask - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateUnderstandTaskRequest - properties: - UniqueName: - type: string - description: A user-provided string that uniquely identifies this - resource as an alternative to the sid. Unique up to 64 characters - long. - FriendlyName: - type: string - description: A user-provided string that identifies this resource. - It is non-unique and can up to 255 characters long. - Actions: - description: A user-provided JSON object encoded as a string to - specify the actions for this task. It is optional and non-unique. - ActionsUrl: - type: string - format: uri - description: User-provided HTTP endpoint where from the assistant - fetches actions - required: - - UniqueName - examples: - create: - value: - FriendlyName: friendly_name - UniqueName: unique_name - Actions: '{"say":{"speech":"Your order is ready for pickup"}}' - ActionsUrl: https://example.com/actions_url - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - mountName: task_actions - className: task_actions - pathType: instance - get: - description: Returns JSON actions for this Task. - tags: - - PreviewUnderstandTaskActions - parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - examples: - fetch: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDdddddddddddddddddddddddddddddddd - data: {} - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions - description: OK - security: - - accountSid_authToken: [] - operationId: FetchUnderstandTaskActions - post: - description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. - tags: - - PreviewUnderstandTaskActions - parameters: - - name: AssistantSid - in: path - description: The unique ID of the parent Assistant. - schema: - type: string - required: true - - name: TaskSid - in: path - description: The unique ID of the Task. - schema: - type: string - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_actions' - examples: - update: - value: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDdddddddddddddddddddddddddddddddd - data: {} - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDdddddddddddddddddddddddddddddddd/Actions - description: OK - security: - - accountSid_authToken: [] - operationId: UpdateUnderstandTaskActions - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: UpdateUnderstandTaskActionsRequest - properties: - Actions: - description: The JSON actions that instruct the Assistant how to - perform this task. - examples: - update: - value: - Actions: '{"actions":[{}]}' - /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: - servers: - - url: https://preview.twilio.com - description: '' - x-twilio: - defaultOutputProperties: [] - parent: /Assistants/{AssistantSid}/Tasks/{Sid} - className: task_statistics - pathType: instance - get: - description: '' - tags: - - PreviewUnderstandTaskStatistics - 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: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/preview.understand.assistant.task.task_statistics' - examples: - fetch: - value: - url: https://preview.twilio.com/understand/Assistants/UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Tasks/UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Statistics - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - assistant_sid: UAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - task_sid: UDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - samples_count: 0 - fields_count: 0 + url: https://preview.twilio.com/Sync/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/sidOrUniqueName/Permissions?PageSize=50&Page=0 description: OK security: - accountSid_authToken: [] - operationId: FetchUnderstandTaskStatistics + operationId: ListSyncSyncMapPermission /wireless/Commands/{Sid}: servers: - url: https://preview.twilio.com @@ -12440,7 +8722,7 @@ paths: usage: mapping: sim_sid: sid - resource_url: /wirelessNone + resource_url: /wireless/Sims/{sim_sid}/Usage pathType: instance get: description: '' @@ -12668,7 +8950,7 @@ paths: usage: mapping: sim_sid: sid - resource_url: /wirelessNone + resource_url: /wireless/Sims/{sim_sid}/Usage pathType: list get: description: '' @@ -12885,3 +9167,5 @@ tags: - name: PreviewDeployedDevicesDevice - name: PreviewDeployedDevicesFleet - name: PreviewDeployedDevicesKey +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index e90a0714..c6d86ecb 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -874,3 +874,5 @@ servers: tags: - name: PricingV1Country - name: PricingV1Number +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index 5798855d..f00df7e5 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -884,3 +884,5 @@ servers: tags: - name: PricingV2Country - name: PricingV2Number +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 2e845725..39736297 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -45,6 +45,10 @@ components: description: 'A JSON string that includes the message body of message interactions (e.g. `{"body": "hello"}`) or the call duration (when available) of a call (e.g. `{"duration": "5"}`).' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/interaction_enum_type' @@ -66,7 +70,7 @@ components: pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) - or [Message](https://www.twilio.com/docs/sms/api/message. + or [Message](https://www.twilio.com/docs/sms/api/message-resource). inbound_resource_status: type: string $ref: '#/components/schemas/interaction_enum_resource_status' @@ -204,6 +208,10 @@ components: nullable: true description: 'A JSON string that includes the message body sent to the participant. (e.g. `{"body": "hello"}`)' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 type: type: string $ref: '#/components/schemas/message_interaction_enum_type' @@ -370,6 +378,10 @@ components: nullable: true description: The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 proxy_identifier: type: string nullable: true @@ -2917,7 +2929,7 @@ paths: minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ - description: The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) + description: The SID of a Twilio [ShortCode](https://www.twilio.com/en-us/messaging/channels/sms/short-codes) resource that represents the short code you would like to assign to your Proxy Service. required: @@ -3193,3 +3205,5 @@ tags: - name: ProxyV1Service - name: ProxyV1Session - name: ProxyV1ShortCode +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index 05d2168a..4e243978 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -437,3 +437,5 @@ tags: - name: RoutesV2PhoneNumber - name: RoutesV2SipDomain - name: RoutesV2Trunk +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index 1230b572..5317b039 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -35,6 +35,10 @@ components: nullable: true description: The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -100,6 +104,10 @@ components: slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. + x-twilio: + pii: + handling: standard + deleteSla: 7 visibility: type: string $ref: '#/components/schemas/asset_version_enum_visibility' @@ -215,6 +223,7 @@ components: - node12 - node14 - node16 + - node18 serverless.v1.service.build.build_status: type: object properties: @@ -356,17 +365,29 @@ components: nullable: true description: A user-defined string that uniquely identifies the Environment resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 domain_suffix: type: string nullable: true description: A URL-friendly name that represents the environment and forms part of the domain name. + x-twilio: + pii: + handling: standard + deleteSla: 7 domain_name: type: string nullable: true description: The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -423,6 +444,10 @@ components: nullable: true description: The string that you assigned to describe the Function resource. It can be a maximum of 255 characters. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -489,6 +514,10 @@ components: with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one. + x-twilio: + pii: + handling: standard + deleteSla: 7 visibility: type: string $ref: '#/components/schemas/function_version_enum_visibility' @@ -669,12 +698,20 @@ components: type: string nullable: true description: The string that you assigned to describe the Service resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 unique_name: type: string nullable: true description: A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's `sid` in the URL to address the Service resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 include_credentials: type: boolean nullable: true @@ -751,10 +788,18 @@ components: type: string nullable: true description: A string by which the Variable resource can be referenced. + x-twilio: + pii: + handling: standard + deleteSla: 7 value: type: string nullable: true description: A string that contains the actual value of the Variable. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -1264,7 +1309,7 @@ paths: mapping: service_sid: service_sid sid: sid - resource_url: /v1None + resource_url: /v1/Services/{service_sid}/Builds/{sid}/Status parent: /Services/{Sid} pathType: list get: @@ -1393,7 +1438,7 @@ paths: version: 3.29.2 - name: '@twilio/runtime-handler' version: 1.0.1 - runtime: node16 + runtime: node18 status: building date_created: '2018-11-10T20:00:00Z' date_updated: '2018-11-10T20:00:00Z' @@ -1462,7 +1507,7 @@ paths: mapping: service_sid: service_sid sid: sid - resource_url: /v1None + resource_url: /v1/Services/{service_sid}/Builds/{sid}/Status parent: /Services/{Sid} pathType: instance get: @@ -1518,7 +1563,7 @@ paths: version: 3.29.2 - name: '@twilio/runtime-handler' version: 1.0.1 - runtime: node16 + runtime: node18 status: building date_created: '2018-11-10T20:00:00Z' date_updated: '2018-11-10T20:00:00Z' @@ -2411,7 +2456,7 @@ paths: service_sid: service_sid function_sid: function_sid sid: sid - resource_url: /v1None + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions pathType: list @@ -2523,7 +2568,7 @@ paths: service_sid: service_sid function_sid: function_sid sid: sid - resource_url: /v1None + resource_url: /v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content parent: /Services/{ServiceSid}/Functions/{Sid} mountName: function_versions pathType: instance @@ -3502,3 +3547,5 @@ tags: - name: ServerlessV1Log - name: ServerlessV1Service - name: ServerlessV1Variable +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index 6d0a39c5..f2ad1945 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -157,12 +157,20 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. + x-twilio: + pii: + handling: standard + deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -212,6 +220,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 flow_sid: type: string minLength: 34 @@ -274,6 +286,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -321,6 +337,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 execution_sid: type: string minLength: 34 @@ -447,6 +467,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -494,6 +518,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 engagement_sid: type: string minLength: 34 @@ -554,7 +582,7 @@ paths: mapping: flow_sid: flow_sid engagement_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} pathType: list get: @@ -736,7 +764,7 @@ paths: mapping: flow_sid: flow_sid engagement_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} pathType: instance get: @@ -889,7 +917,7 @@ paths: mapping: flow_sid: flow_sid execution_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: list get: @@ -1086,7 +1114,7 @@ paths: mapping: flow_sid: flow_sid execution_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: instance get: @@ -1300,7 +1328,7 @@ paths: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: list @@ -1412,7 +1440,7 @@ paths: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: instance @@ -1727,7 +1755,7 @@ paths: flow_sid: flow_sid engagement_sid: engagement_sid step_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} pathType: list get: @@ -1839,7 +1867,7 @@ paths: flow_sid: flow_sid engagement_sid: engagement_sid step_sid: sid - resource_url: /v1None + resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} pathType: instance get: @@ -1974,3 +2002,5 @@ tags: - name: StudioV1Flow - name: StudioV1Step - name: StudioV1StepContext +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 2316358c..14aa1828 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -37,12 +37,20 @@ components: the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. + x-twilio: + pii: + handling: standard + deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/execution_enum_status' @@ -92,6 +100,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 flow_sid: type: string minLength: 34 @@ -154,6 +166,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 transitioned_from: type: string nullable: true @@ -201,6 +217,10 @@ components: we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. + x-twilio: + pii: + handling: standard + deleteSla: 30 execution_sid: type: string minLength: 34 @@ -446,7 +466,7 @@ paths: mapping: flow_sid: flow_sid execution_sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: list get: @@ -641,7 +661,7 @@ paths: mapping: flow_sid: flow_sid execution_sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: instance get: @@ -853,7 +873,7 @@ paths: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: list @@ -965,7 +985,7 @@ paths: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: instance @@ -1109,7 +1129,7 @@ paths: test_users: mapping: sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{sid}/TestUsers executions: mapping: flow_sid: sid @@ -1291,7 +1311,7 @@ paths: test_users: mapping: sid: sid - resource_url: /v2None + resource_url: /v2/Flows/{sid}/TestUsers executions: mapping: flow_sid: sid @@ -1766,3 +1786,5 @@ tags: - name: StudioV2FlowRevision - name: StudioV2FlowTestUser - name: StudioV2FlowValidate +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 6bfddcde..98530005 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -87,20 +87,25 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the Sim resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 sim_sid: type: string minLength: 34 maxLength: 34 pattern: ^HS[0-9a-fA-F]{32}$ nullable: true - description: The SID of the [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) + description: The SID of the [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource that this eSIM Profile controls. status: type: string $ref: '#/components/schemas/esim_profile_enum_status' nullable: true - description: 'The status of the eSIM Profile. Can be: `reserving`, `available`, - `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) + description: 'The status of the eSIM Profile. Can be: `new`, `reserving`, + `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile + Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each.' eid: type: string @@ -360,6 +365,10 @@ components: \ in binary encoding. For an IP Command sent from a Super SIM, the payload\ \ should not exceed 1300 bytes. If it is larger than 1300 bytes, there\ \ might be fragmentation on the upstream and the message may appear truncated." + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -601,6 +610,10 @@ components: nullable: true description: The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with the SIM. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/sim_enum_status' @@ -699,6 +712,10 @@ components: nullable: true description: The message body of the SMS Command sent to or from the SIM. For text mode messages, this can be up to 160 characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 status: type: string $ref: '#/components/schemas/sms_command_enum_status' @@ -1129,7 +1146,7 @@ paths: value: 89049032005008882600033489aaaaaa - name: SimSid in: query - description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/wireless/api/sim-resource) + description: Find the eSIM Profile resource related to a [Sim](https://www.twilio.com/docs/iot/supersim/api/sim-resource) resource by providing the SIM SID. Will always return an array with either 1 or 0 records. schema: @@ -3035,6 +3052,10 @@ paths: will always return a list containing zero or one SIMs. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readByIccid: value: '89883070000123456789' @@ -4414,3 +4435,5 @@ tags: - name: SupersimV1SimIpAddress - name: SupersimV1SmsCommand - name: SupersimV1UsageRecord +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index 714e7d98..b8820a14 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -21,6 +21,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -57,6 +61,10 @@ components: nullable: true description: An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -84,6 +92,10 @@ components: is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.document.document_permission: type: object properties: @@ -116,6 +128,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -162,6 +178,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 7 date_created: type: string format: date-time @@ -237,6 +257,10 @@ components: nullable: true description: An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 0 sync.v1.service.sync_list: type: object properties: @@ -254,6 +278,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -310,6 +338,10 @@ components: description: The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.sync_list.sync_list_item: type: object properties: @@ -354,6 +386,10 @@ components: nullable: true description: An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -380,6 +416,10 @@ components: description: The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync_list_item_enum_query_result_order: type: string enum: @@ -421,6 +461,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -456,6 +500,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -512,6 +560,10 @@ components: description: The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync.v1.service.sync_map.sync_map_item: type: object properties: @@ -519,6 +571,10 @@ components: type: string nullable: true description: The unique, user-defined key for the Map Item. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -555,6 +611,10 @@ components: nullable: true description: An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length. + x-twilio: + pii: + handling: sensitive + deleteSla: 7 date_expires: type: string format: date-time @@ -581,6 +641,10 @@ components: description: The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sync_map_item_enum_query_result_order: type: string enum: @@ -622,6 +686,10 @@ components: nullable: true description: The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. + x-twilio: + pii: + handling: standard + deleteSla: 30 read: type: boolean nullable: true @@ -657,6 +725,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -709,6 +781,10 @@ components: description: The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'. + x-twilio: + pii: + handling: standard + deleteSla: 30 info: title: Twilio - Sync description: This is the public Twilio REST API. @@ -1104,6 +1180,10 @@ paths: Document Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -1151,6 +1231,10 @@ paths: Document Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -1183,6 +1267,10 @@ paths: Document Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2618,6 +2706,10 @@ paths: Sync List Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2665,6 +2757,10 @@ paths: Sync List Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -2697,6 +2793,10 @@ paths: Sync List Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -3254,6 +3354,10 @@ paths: description: The `key` value of the Sync Map Item resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -3303,6 +3407,10 @@ paths: description: The `key` value of the Sync Map Item resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: If-Match in: header @@ -3342,6 +3450,10 @@ paths: description: 'The `key` value of the Sync Map Item resource to update. ' schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: If-Match in: header @@ -3683,6 +3795,10 @@ paths: Sync Map Permission resource to fetch. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -3731,6 +3847,10 @@ paths: Sync Map Permission resource to delete. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -3764,6 +3884,10 @@ paths: Sync Map Permission resource to update. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -4273,3 +4397,5 @@ tags: - name: SyncV1SyncMapItem - name: SyncV1SyncMapPermission - name: SyncV1SyncStream +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 0f846800..16930877 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -184,11 +184,15 @@ components: If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null. + x-twilio: + pii: + handling: sensitive + deleteSla: 30 addons: type: string nullable: true - description: An object that contains the [addon](https://www.twilio.com/docs/taskrouter/marketplace) - data for all installed addons. + description: An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) + data for all installed Add-ons. date_created: type: string format: date-time @@ -397,6 +401,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 max_reserved_workers: type: integer nullable: true @@ -463,7 +471,7 @@ components: enum: - FIFO - LIFO - taskrouter.v1.task_queue_bulk_real_time_statistics: + taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics: type: object properties: account_sid: @@ -485,18 +493,40 @@ components: type: array items: {} nullable: true - 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.' + description: 'The real-time statistics for each requested TaskQueue SID. + `task_queue_data` returns the following attributes: + + + `task_queue_sid`: The SID of the TaskQueue from which these statistics + were calculated. + + + `total_available_workers`: The total number of Workers available for Tasks + in the TaskQueue. + + + `total_eligible_workers`: The total number of Workers eligible for Tasks + in the TaskQueue, regardless of their Activity state. + + + `total_tasks`: The total number of Tasks. + + + `longest_task_waiting_age`: The age of the longest waiting Task. + + + `longest_task_waiting_sid`: The SID of the longest waiting Task. + + + `tasks_by_status`: The number of Tasks grouped by their current status. + + + `tasks_by_priority`: The number of Tasks grouped by priority. + + + `activity_statistics`: The number of current Workers grouped by Activity. + + ' task_queue_response_count: type: integer nullable: true @@ -907,6 +937,10 @@ components: actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.' + x-twilio: + pii: + handling: sensitive + deleteSla: 30 available: type: boolean nullable: true @@ -935,6 +969,10 @@ components: nullable: true description: The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace. + x-twilio: + pii: + handling: standard + deleteSla: 30 sid: type: string minLength: 34 @@ -1353,6 +1391,10 @@ components: nullable: true description: The string that you assigned to describe the Workflow resource. For example, `Customer Support` or `2014 Election Campaign`. + x-twilio: + pii: + handling: standard + deleteSla: 30 sid: type: string minLength: 34 @@ -1642,6 +1684,10 @@ components: nullable: true description: The string that you assigned to describe the Workspace resource. For example `Customer Support` or `2014 Election Campaign`. + x-twilio: + pii: + handling: standard + deleteSla: 30 multi_task_enabled: type: boolean nullable: true @@ -2955,8 +3001,8 @@ paths: type: string - name: HasAddons in: query - description: Whether to read Tasks with addons. If `true`, returns only Tasks - with addons. If `false`, returns only Tasks without addons. + description: Whether to read Tasks with Add-ons. If `true`, returns only Tasks + with Add-ons. If `false`, returns only Tasks without Add-ons. schema: type: boolean - name: PageSize @@ -3561,17 +3607,17 @@ paths: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics real_time_statistics: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics parent: /Workspaces/{Sid} pathType: instance get: @@ -3621,6 +3667,7 @@ paths: real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + bulk_real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -3680,6 +3727,7 @@ paths: real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + bulk_real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -3788,17 +3836,17 @@ paths: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics real_time_statistics: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid task_queue_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/CumulativeStatistics parent: /Workspaces/{Sid} pathType: list get: @@ -3820,6 +3868,10 @@ paths: description: The `friendly_name` of the TaskQueue resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -3930,6 +3982,7 @@ paths: real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + bulk_real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -3991,6 +4044,7 @@ paths: real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RealTimeStatistics cumulative_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CumulativeStatistics list_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/Statistics + bulk_real_time_statistics: https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics reservation_activity_name: 80fa2beb-3a05-11e5-8fc8-98e0d9a1eb73 reservation_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4067,6 +4121,9 @@ paths: defaultOutputProperties: - account_sid - workspace_sid + - task_queue_data + - task_queue_response_count + parent: /Workspaces/{WorkspaceSid}/TaskQueues mountName: bulk_real_time_statistics className: task_queue_bulk_real_time_statistics pathType: list @@ -4090,7 +4147,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/taskrouter.v1.task_queue_bulk_real_time_statistics' + $ref: '#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics' examples: create: value: @@ -5311,6 +5368,10 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + JitterBufferSize: + type: string + description: 'The jitter buffer size for conference. Can be: `small`, + `medium`, `large`, `off`.' examples: update: value: @@ -5333,16 +5394,16 @@ paths: real_time_statistics: mapping: workspace_sid: workspace_sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics statistics: mapping: workspace_sid: workspace_sid worker_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics reservations: mapping: workspace_sid: workspace_sid @@ -5410,6 +5471,10 @@ paths: description: The `friendly_name` of the Worker resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -5659,16 +5724,16 @@ paths: real_time_statistics: mapping: workspace_sid: workspace_sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/CumulativeStatistics statistics: mapping: workspace_sid: workspace_sid worker_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics reservations: mapping: workspace_sid: workspace_sid @@ -6843,6 +6908,10 @@ paths: type: boolean description: Whether to play a notification beep when the customer joins. + JitterBufferSize: + type: string + description: 'The jitter buffer size for conference. Can be: `small`, + `medium`, `large`, `off`.' examples: update: value: @@ -7185,17 +7254,17 @@ paths: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics real_time_statistics: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics parent: /Workspaces/{Sid} pathType: instance get: @@ -7396,17 +7465,17 @@ paths: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics real_time_statistics: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: workspace_sid workflow_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/CumulativeStatistics parent: /Workspaces/{Sid} pathType: list get: @@ -7428,6 +7497,10 @@ paths: description: The `friendly_name` of the Workflow resources to read. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -7993,15 +8066,15 @@ paths: statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Statistics real_time_statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/CumulativeStatistics task_channels: mapping: workspace_sid: sid @@ -8235,15 +8308,15 @@ paths: statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/Statistics real_time_statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/RealTimeStatistics cumulative_statistics: mapping: workspace_sid: sid - resource_url: /v1None + resource_url: /v1/Workspaces/{workspace_sid}/CumulativeStatistics task_channels: mapping: workspace_sid: sid @@ -8260,6 +8333,10 @@ paths: `Customer Support` or `2014 Election Campaign`. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readFull: value: friendly_name @@ -8838,3 +8915,5 @@ tags: - name: TaskrouterV1WorkspaceCumulativeStatistics - name: TaskrouterV1WorkspaceRealTimeStatistics - name: TaskrouterV1WorkspaceStatistics +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index 1c1c091f..25f15dd6 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -142,6 +142,10 @@ components: nullable: true description: The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -219,6 +223,10 @@ components: type: string nullable: true description: The string that you assigned to describe the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 links: type: object format: uri-map @@ -450,6 +458,10 @@ components: URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information. + x-twilio: + pii: + handling: standard + deleteSla: 30 friendly_name: type: string nullable: true @@ -1893,7 +1905,7 @@ paths: recordings: mapping: trunk_sid: sid - resource_url: /v1None + resource_url: /v1/Trunks/{trunk_sid}/Recording pathType: instance get: description: '' @@ -2120,7 +2132,7 @@ paths: recordings: mapping: trunk_sid: sid - resource_url: /v1None + resource_url: /v1/Trunks/{trunk_sid}/Recording pathType: list post: description: '' @@ -2354,3 +2366,5 @@ tags: - name: TrunkingV1PhoneNumber - name: TrunkingV1Recording - name: TrunkingV1Trunk +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index 4bf54811..ae3acb02 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -27,6 +27,85 @@ components: format: uri nullable: true description: The URL of this resource. + trusthub.v1.compliance_registration: + type: object + properties: + inquiry_id: + type: string + nullable: true + description: The unique ID used to start an embedded compliance registration + session. + inquiry_session_token: + type: string + nullable: true + description: The session token used to start an embedded compliance registration + session. + registration_id: + type: string + nullable: true + description: The RegistrationId matching the Registration Profile that should + be resumed or resubmitted for editing. + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + compliance_registration_enum_end_user_type: + type: string + enum: + - Individual + - Business + compliance_registration_enum_phone_number_type: + type: string + enum: + - local + - national + - mobile + - toll-free + compliance_registration_enum_business_identity_type: + type: string + enum: + - direct_customer + - isv_reseller_or_partner + - unknown + trusthub.v1.compliance_tollfree_inquiry: + type: object + properties: + inquiry_id: + type: string + nullable: true + description: The unique ID used to start an embedded compliance registration + session. + inquiry_session_token: + type: string + nullable: true + description: The session token used to start an embedded compliance registration + session. + registration_id: + type: string + nullable: true + description: The TolfreeId matching the Tollfree Profile that should be + resumed or resubmitted for editing. + url: + type: string + format: uri + nullable: true + description: The URL of this resource. + compliance_tollfree_inquiry_enum_status: + type: string + enum: + - PENDING_REVIEW + - IN_REVIEW + - TWILIO_APPROVED + - TWILIO_REJECTED + compliance_tollfree_inquiry_enum_opt_in_type: + type: string + enum: + - VERBAL + - WEB_FORM + - PAPER_FORM + - VIA_TEXT + - MOBILE_QR_CODE trusthub.v1.customer_profile: type: object properties: @@ -299,6 +378,10 @@ components: nullable: true description: The set of parameters that are the attributes of the End Users resource which are listed in the End User Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -417,6 +500,10 @@ components: nullable: true description: The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -760,6 +847,12 @@ paths: inquiry_session_token: new.session.token customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize + createWithNotificationEmail: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + customer_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Customers/tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.customer.BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Initialize description: Created security: - accountSid_authToken: [] @@ -779,12 +872,21 @@ paths: description: The unique SID identifier of the Primary Customer Profile that should be used as a parent. Only necessary when creating a secondary Customer Profile. + NotificationEmail: + type: string + description: The email address that approval status updates will + be sent to. If not specified, the email address associated with + your primary customer profile will be used. required: - PrimaryProfileSid examples: create: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + createWithNotificationEmail: + value: + PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + NotificationEmail: pfarnsworth@twilio.com /v1/ComplianceInquiries/Customers/{CustomerId}/Initialize: servers: - url: https://trusthub.twilio.com @@ -849,6 +951,351 @@ paths: update: value: PrimaryProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + /v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - registration_id + mountName: compliance_registration_inquiries + className: compliance_registration_inquiries + pathType: list + post: + description: Create a new Compliance Registration Inquiry for the authenticated + account. This is necessary to start a new embedded session. + tags: + - TrusthubV1ComplianceRegistrationInquiries + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/trusthub.v1.compliance_registration' + examples: + create: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + registration_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.registartion.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize + description: Created + security: + - accountSid_authToken: [] + operationId: CreateComplianceRegistration + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateComplianceRegistrationRequest + properties: + EndUserType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_end_user_type' + description: The type of End User the regulation requires - can + be `Individual` or `Business`. + PhoneNumberType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_phone_number_type' + description: The type of phone number of the Bundle's ownership + request. Can be `local`, `mobile`, `national`, or `toll-free`. + BusinessIdentityType: + type: string + $ref: '#/components/schemas/compliance_registration_enum_business_identity_type' + description: The type of business identity. Can be `direct customer` + or `ISV`. + BusinessRegistrationAuthority: + type: string + description: The authority that registered the business + BusinessLegalName: + type: string + description: he name of the business or organization using the Tollfree + number. + NotificationEmail: + type: string + description: he email address to receive the notification about + the verification result. + AcceptedNotificationReceipt: + type: boolean + description: The email address to receive the notification about + the verification result. + BusinessRegistrationNumber: + type: string + description: Business registration number of the business + BusinessWebsiteUrl: + type: string + description: The URL of the business website + FriendlyName: + type: string + description: Friendly name for your business information + AuthorizedRepresentative1FirstName: + type: string + description: First name of the authorized representative + AuthorizedRepresentative1LastName: + type: string + description: Last name of the authorized representative + AuthorizedRepresentative1Phone: + type: string + description: Phone number of the authorized representative + AuthorizedRepresentative1Email: + type: string + description: Email address of the authorized representative + AuthorizedRepresentative1DateOfBirth: + type: string + description: Birthdate of the authorized representative + AddressStreet: + type: string + description: Street address of the business + AddressStreetSecondary: + type: string + description: Street address of the business + AddressCity: + type: string + description: City of the business + AddressSubdivision: + type: string + description: State or province of the business + AddressPostalCode: + type: string + description: Postal code of the business + AddressCountryCode: + type: string + description: Country code of the business + EmergencyAddressStreet: + type: string + description: Street address of the business + EmergencyAddressStreetSecondary: + type: string + description: Street address of the business + EmergencyAddressCity: + type: string + description: City of the business + EmergencyAddressSubdivision: + type: string + description: State or province of the business + EmergencyAddressPostalCode: + type: string + description: Postal code of the business + EmergencyAddressCountryCode: + type: string + description: Country code of the business + UseAddressAsEmergencyAddress: + type: boolean + description: Use the business address as the emergency address + FileName: + type: string + description: The name of the verification document to upload + File: + type: string + description: The verification document to upload + required: + - EndUserType + - PhoneNumberType + examples: + create: + value: + EndUserType: Individual + PhoneNumberType: national + BusinessLegalName: Owl, Inc. + NotificationEmail: test@test.com + AcceptedNotificationReceipt: true + BusinessRegistrationNumber: '123456789' + BusinessWebsiteUrl: https://twilio.co + FriendlyName: Owl + AuthorizedRepresentative1FirstName: firstname + AuthorizedRepresentative1LastName: lastname + AuthorizedRepresentative1Email: test@test.com + AuthorizedRepresentative1DateOfBirth: '1990-01-01' + AddressStreet: 123 Main St + AddressStreetSecondary: Apt 1 + AddressCity: San Francisco + AddressSubdivision: CA + AddressPostalCode: '94107' + AddressCountryCode: US + UseAddressAsEmergencyAddress: true + EmergencyAddressStreet: 123 Main St + EmergencyAddressStreetSecondary: Apt 1 + EmergencyAddressCity: San Francisco + EmergencyAddressSubdivision: CA + EmergencyAddressPostalCode: '94107' + EmergencyAddressCountryCode: US + FileName: fileName + File: file + BusinessIdentityType: direct_customer + BusinessRegistrationAuthority: ein + /v1/ComplianceInquiries/Tollfree/Initialize: + servers: + - url: https://trusthub.twilio.com + description: '' + x-twilio: + defaultOutputProperties: + - inquiry_id + - session_token + - registration_id + mountName: compliance_tollfree_inquiries + className: compliance_tollfree_inquiries + pathType: list + post: + description: Create a new Compliance Tollfree Verification Inquiry for the authenticated + account. This is necessary to start a new embedded session. + tags: + - TrusthubV1ComplianceTollfreeInquiries + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/trusthub.v1.compliance_tollfree_inquiry' + examples: + create: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + registration_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize + create2: + value: + inquiry_id: inq_aaaaaaaaaaaaaaaaaaaaaaaa + inquiry_session_token: new.session.token + registration_id: tri1.us1.trusthub.ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.tollfree.PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + url: https://trusthub.twilio.com/v1/ComplianceInquiries/Tollfree/Initialize + description: Created + security: + - accountSid_authToken: [] + operationId: CreateComplianceTollfreeInquiry + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateComplianceTollfreeInquiryRequest + properties: + TollfreePhoneNumber: + type: string + format: phone-number + description: The Tollfree phone number to be verified + NotificationEmail: + type: string + description: The email address to receive the notification about + the verification result. + BusinessName: + type: string + description: The name of the business or organization using the + Tollfree number. + BusinessWebsite: + type: string + description: The website of the business or organization using the + Tollfree number. + UseCaseCategories: + type: array + items: + type: string + description: The category of the use case for the Tollfree Number. + List as many are applicable.. + UseCaseSummary: + type: string + description: Use this to further explain how messaging is used by + the business or organization. + ProductionMessageSample: + type: string + description: An example of message content, i.e. a sample message. + OptInImageUrls: + type: array + items: + type: string + description: Link to an image that shows the opt-in workflow. Multiple + images allowed and must be a publicly hosted URL. + OptInType: + type: string + $ref: '#/components/schemas/compliance_tollfree_inquiry_enum_opt_in_type' + description: Describe how a user opts-in to text messages. + MessageVolume: + type: string + description: Estimate monthly volume of messages from the Tollfree + Number. + BusinessStreetAddress: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessStreetAddress2: + type: string + description: The address of the business or organization using the + Tollfree number. + BusinessCity: + type: string + description: The city of the business or organization using the + Tollfree number. + BusinessStateProvinceRegion: + type: string + description: The state/province/region of the business or organization + using the Tollfree number. + BusinessPostalCode: + type: string + description: The postal code of the business or organization using + the Tollfree number. + BusinessCountry: + type: string + description: The country of the business or organization using the + Tollfree number. + AdditionalInformation: + type: string + description: Additional information to be provided for verification. + BusinessContactFirstName: + type: string + description: The first name of the contact for the business or organization + using the Tollfree number. + BusinessContactLastName: + type: string + description: The last name of the contact for the business or organization + using the Tollfree number. + BusinessContactEmail: + type: string + description: The email address of the contact for the business or + organization using the Tollfree number. + BusinessContactPhone: + type: string + format: phone-number + description: The phone number of the contact for the business or + organization using the Tollfree number. + required: + - TollfreePhoneNumber + - NotificationEmail + examples: + create: + value: + TollfreePhoneNumber: '+123445566' + NotificationEmail: jeff@twilio.com + create2: + value: + TollfreePhoneNumber: '+123445566' + NotificationEmail: jeff@twilio.com + BusinessName: Owl, Inc. + BusinessStreetAddress: 123 Main Street + BusinessStreetAddress2: Suite 101 + BusinessCity: Anytown + BusinessStateProvinceRegion: AA + BusinessPostalCode: '11111' + BusinessCountry: US + BusinessWebsite: http://www.company.com + BusinessContactFirstName: firstname + BusinessContactLastName: lastname + BusinessContactEmail: email@company.com + BusinessContactPhone: '+1231231234' + UseCaseCategories: + - TWO_FACTOR_AUTHENTICATION + - MARKETING + UseCaseSummary: This number is used to send out promotional offers + and coupons to the customers of John's Coffee Shop + ProductionMessageSample: lorem ipsum + OptInImageUrls: + - https://testbusiness.com/images/image1.jpg + - https://testbusiness.com/images/image2.jpg + OptInType: VERBAL + MessageVolume: '10' + AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy /v1/CustomerProfiles: servers: - url: https://trusthub.twilio.com @@ -5428,6 +5875,8 @@ servers: - url: https://trusthub.twilio.com tags: - name: TrusthubV1ComplianceInquiries +- name: TrusthubV1ComplianceRegistrationInquiries +- name: TrusthubV1ComplianceTollfreeInquiries - name: TrusthubV1CustomerProfiles - name: TrusthubV1CustomerProfilesChannelEndpointAssignment - name: TrusthubV1CustomerProfilesEntityAssignments @@ -5441,3 +5890,5 @@ tags: - name: TrusthubV1TrustProductsChannelEndpointAssignment - name: TrusthubV1TrustProductsEntityAssignments - name: TrusthubV1TrustProductsEvaluations +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 67c3bb9f..41550900 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -43,6 +43,10 @@ components: nullable: true description: A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name. + x-twilio: + pii: + handling: standard + deleteSla: 30 token: type: string nullable: true @@ -165,6 +169,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 factor_sid: type: string minLength: 34 @@ -213,17 +221,29 @@ components: nullable: true description: Details provided to give context about the Challenge. Intended to be shown to the end user. + x-twilio: + pii: + handling: standard + deleteSla: 30 hidden_details: nullable: true description: 'Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{"ip": "172.168.1.234"}`' + x-twilio: + pii: + handling: standard + deleteSla: 30 metadata: nullable: true description: 'Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' + x-twilio: + pii: + handling: standard + deleteSla: 30 factor_type: type: string $ref: '#/components/schemas/challenge_enum_factor_types' @@ -282,6 +302,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -358,6 +382,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 date_created: type: string format: date-time @@ -394,6 +422,10 @@ components: by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -536,6 +568,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 binding: nullable: true description: "Contains the `factor_type` specific secret and metadata.\n\ @@ -586,6 +622,10 @@ components: by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{"os": "Android"}`. Can be up to 1024 characters in length.' + x-twilio: + pii: + handling: standard + deleteSla: 30 url: type: string format: uri @@ -652,6 +692,10 @@ components: characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. + x-twilio: + pii: + handling: standard + deleteSla: 30 challenge_sid: type: string minLength: 34 @@ -748,6 +792,10 @@ components: type: string nullable: true description: The phone number in SafeList. + x-twilio: + pii: + handling: standard + deleteSla: 0 url: type: string format: uri @@ -831,6 +879,11 @@ components: maxLength: 34 pattern: ^HJ[0-9a-fA-F]{32}$ nullable: true + verify_event_subscription_enabled: + type: boolean + nullable: true + description: Whether to allow verifications from the service to reach the + stream-events sinks if configured date_created: type: string format: date-time @@ -885,12 +938,16 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + x-twilio: + pii: + handling: standard + deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_enum_channel' nullable: true description: 'The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), - `sms`, `whatsapp`, `call`, or `sna`.' + `sms`, `whatsapp`, `call`, `sna`, or `rcs`.' status: type: string nullable: true @@ -909,11 +966,19 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 send_code_attempts: type: array items: {} @@ -1024,7 +1089,7 @@ components: description: An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately - available. More information on pricing is available [here](https://www.twilio.com/verify/pricing). + available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing). channel_data: nullable: true description: An object containing the channel specific information for an @@ -1143,6 +1208,10 @@ components: nullable: true description: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). + x-twilio: + pii: + handling: standard + deleteSla: 30 channel: type: string $ref: '#/components/schemas/verification_check_enum_channel' @@ -1164,11 +1233,19 @@ components: nullable: true description: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 payee: type: string nullable: true description: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. + x-twilio: + pii: + handling: sensitive + deleteSla: 1 date_created: type: string format: date-time @@ -1937,6 +2014,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '201': @@ -2124,6 +2205,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: FactorSid in: query @@ -2319,6 +2404,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2390,6 +2479,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2733,6 +2826,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '204': @@ -2762,6 +2859,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '200': @@ -2821,6 +2922,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2859,6 +2964,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -2942,6 +3051,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: Sid in: path @@ -3096,6 +3209,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: PageSize in: query @@ -3246,6 +3363,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true responses: '201': @@ -3845,6 +3966,10 @@ paths: SID. It can only contain dash (-) separated alphanumeric characters. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 required: true - name: ChallengeSid in: path @@ -4314,6 +4439,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 required: true responses: '200': @@ -4342,6 +4471,10 @@ paths: be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 0 required: true responses: '204': @@ -4423,6 +4556,7 @@ paths: code_length: 3 skew: 2 default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4542,6 +4676,10 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. + VerifyEventSubscriptionEnabled: + type: boolean + description: Whether to allow verifications from the service to + reach the stream-events sinks if configured required: - FriendlyName examples: @@ -4563,6 +4701,7 @@ paths: Totp.CodeLength: 3 Totp.Skew: 2 DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VerifyEventSubscriptionEnabled: false get: description: Retrieve a list of all Verification Services for an account. tags: @@ -4656,6 +4795,7 @@ paths: code_length: null skew: null default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4756,6 +4896,7 @@ paths: code_length: null skew: null default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4838,6 +4979,7 @@ paths: code_length: 3 skew: 2 default_template_sid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + verify_event_subscription_enabled: false date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa @@ -4951,6 +5093,10 @@ paths: description: The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only. + VerifyEventSubscriptionEnabled: + type: boolean + description: Whether to allow verifications from the service to + reach the stream-events sinks if configured examples: updateRecord: value: @@ -4971,6 +5117,7 @@ paths: Totp.CodeLength: 3 Totp.Skew: 2 DefaultTemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + VerifyEventSubscriptionEnabled: false /v2/Services/{ServiceSid}/Verifications: servers: - url: https://verify.twilio.com @@ -5236,6 +5383,12 @@ 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 @@ -5255,6 +5408,7 @@ paths: TemplateSid: HJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa TemplateCustomSubstitutions: '{"AppName": "MyApp", "Contact":"12345689"}' RiskCheck: enable + Tags: '{"tenant_id": "12345"}' createVerificationWhatsapp: value: To: '+15017122661' @@ -5492,6 +5646,10 @@ paths: description: Destination of a verification. It is phone number in E.164 format. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 - name: Country in: query description: Filter used to query Verification Attempts sent to the specified @@ -6472,3 +6630,5 @@ tags: - name: VerifyV2VerificationAttemptsSummary - name: VerifyV2VerificationCheck - name: VerifyV2Webhook +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 6b5a3ae6..8db0b146 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -75,6 +75,10 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. + x-twilio: + pii: + handling: standard + deleteSla: 30 audio_sources_excluded: type: array items: @@ -86,11 +90,19 @@ components: property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. + x-twilio: + pii: + handling: standard + deleteSla: 30 video_layout: nullable: true description: An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. + x-twilio: + pii: + handling: standard + deleteSla: 30 resolution: type: string nullable: true @@ -230,6 +242,10 @@ components: in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request + x-twilio: + pii: + handling: standard + deleteSla: 30 audio_sources_excluded: type: array items: @@ -242,6 +258,10 @@ components: can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty. + x-twilio: + pii: + handling: standard + deleteSla: 30 video_layout: nullable: true description: A JSON object that describes the video layout of the composition @@ -249,6 +269,10 @@ components: the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request + x-twilio: + pii: + handling: standard + deleteSla: 30 resolution: type: string nullable: true @@ -333,7 +357,7 @@ components: We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in - the RFC 3986. + the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). aws_storage_enabled: type: boolean nullable: true @@ -440,6 +464,10 @@ components: nullable: true description: The name that was given to the source track of the recording. If no name is given, the `source_sid` is used. + x-twilio: + pii: + handling: standard + deleteSla: 30 offset: type: integer format: int64 @@ -535,7 +563,7 @@ components: We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the - RFC 3986. + [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). aws_storage_enabled: type: boolean nullable: true @@ -1280,7 +1308,7 @@ paths: media: mapping: composition_sid: sid - resource_url: /v1None + resource_url: /v1/Compositions/{composition_sid}/Media pathType: instance get: description: Returns a single Composition resource identified by a Composition @@ -1398,7 +1426,7 @@ paths: media: mapping: composition_sid: sid - resource_url: /v1None + resource_url: /v1/Compositions/{composition_sid}/Media pathType: list get: description: List of all Recording compositions. @@ -2499,8 +2527,7 @@ paths: should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described - in the RFC - 3986. + in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). AwsStorageEnabled: type: boolean description: Whether all compositions should be written to the `aws_s3_url`. @@ -2536,7 +2563,7 @@ paths: media: mapping: recording_sid: sid - resource_url: /v1None + resource_url: /v1/Recordings/{recording_sid}/Media pathType: instance get: description: Returns a single Recording resource identified by a Recording SID. @@ -2624,7 +2651,7 @@ paths: media: mapping: recording_sid: sid - resource_url: /v1None + resource_url: /v1/Recordings/{recording_sid}/Media pathType: list get: description: List of all Track recordings. @@ -2904,8 +2931,7 @@ paths: be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described - in the RFC - 3986. + in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2). AwsStorageEnabled: type: boolean description: Whether all recordings should be written to the `aws_s3_url`. @@ -3614,7 +3640,7 @@ paths: mapping: room_sid: room_sid sid: sid - resource_url: /v1None + resource_url: /v1/Rooms/{room_sid}/Participants/{sid}/Anonymize parent: /Rooms/{Sid} pathType: instance get: @@ -3756,7 +3782,7 @@ paths: mapping: room_sid: room_sid sid: sid - resource_url: /v1None + resource_url: /v1/Rooms/{room_sid}/Participants/{sid}/Anonymize parent: /Rooms/{Sid} pathType: list get: @@ -4413,7 +4439,7 @@ paths: mapping: room_sid: room_sid sid: sid - resource_url: /v1None + resource_url: /v1/Rooms/{room_sid}/Recordings/{sid}/Media parent: /Rooms/{Sid} className: room_recording pathType: instance @@ -4521,7 +4547,7 @@ paths: mapping: room_sid: room_sid sid: sid - resource_url: /v1None + resource_url: /v1/Rooms/{room_sid}/Recordings/{sid}/Media parent: /Rooms/{Sid} className: room_recording pathType: list @@ -4787,3 +4813,5 @@ tags: - name: VideoV1RoomRecording - name: VideoV1SubscribeRules - name: VideoV1SubscribedTrack +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index a4bb13df..0d7f161f 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -53,6 +53,10 @@ components: nullable: true description: The URL we call using the `voice_method` when the BYOC Trunk receives a call. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_method: type: string format: http-method @@ -72,6 +76,10 @@ components: nullable: true description: The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`. + x-twilio: + pii: + handling: standard + deleteSla: 30 voice_fallback_method: type: string format: http-method @@ -91,6 +99,10 @@ components: nullable: true description: The URL that we call to pass status parameters (such as call ended) to your application. + x-twilio: + pii: + handling: standard + deleteSla: 30 status_callback_method: type: string format: http-method @@ -229,6 +241,10 @@ components: nullable: true description: The SIP address you want Twilio to route your calls to. This must be a `sip:` schema. `sips` is NOT supported. + x-twilio: + pii: + handling: standard + deleteSla: 30 priority: type: integer nullable: true @@ -436,6 +452,10 @@ components: type: string nullable: true description: An IP address in dotted decimal notation, IPv4 only. + x-twilio: + pii: + handling: standard + deleteSla: 30 cidr_prefix_length: type: integer nullable: true @@ -2664,3 +2684,5 @@ tags: - name: VoiceV1Recording - name: VoiceV1Settings - name: VoiceV1SourceIpMapping +security: +- accountSid_authToken: [] diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index a0761196..77e23160 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -67,6 +67,10 @@ components: description: The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64. + x-twilio: + pii: + handling: standard + deleteSla: 30 command_mode: type: string $ref: '#/components/schemas/command_enum_command_mode' @@ -349,6 +353,10 @@ components: description: An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 account_sid: type: string minLength: 34 @@ -369,11 +377,19 @@ 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 @@ -2048,6 +2064,10 @@ paths: list with a maximum size of 1. schema: type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 examples: readEmpty: value: iccid @@ -2363,3 +2383,5 @@ tags: - name: WirelessV1RatePlan - name: WirelessV1Sim - name: WirelessV1UsageRecord +security: +- accountSid_authToken: []