From 48d585dd27ed32e2bcb03391cbadedcba87ea664 Mon Sep 17 00:00:00 2001 From: AsabuHere Date: Mon, 27 Jun 2022 13:20:13 +0530 Subject: [PATCH] Updating specs as per new yps changes --- spec/yaml/twilio_api_v2010.yaml | 51 +++++++++ spec/yaml/twilio_chat_v1.yaml | 14 +++ spec/yaml/twilio_chat_v2.yaml | 16 +++ spec/yaml/twilio_chat_v3.yaml | 2 + spec/yaml/twilio_conversations_v1.yaml | 32 ++++++ spec/yaml/twilio_frontline_v1.yaml | 2 + spec/yaml/twilio_insights_v1.yaml | 142 +++++++++++++++++++------ spec/yaml/twilio_ip_messaging_v1.yaml | 14 +++ spec/yaml/twilio_ip_messaging_v2.yaml | 16 +++ spec/yaml/twilio_lookups_v2.yaml | 2 + spec/yaml/twilio_media_v1.yaml | 4 - spec/yaml/twilio_notify_v1.yaml | 4 + spec/yaml/twilio_proxy_v1.yaml | 12 +++ spec/yaml/twilio_supersim_v1.yaml | 2 + spec/yaml/twilio_taskrouter_v1.yaml | 16 +++ spec/yaml/twilio_trunking_v1.yaml | 11 ++ spec/yaml/twilio_verify_v2.yaml | 30 +++++- spec/yaml/twilio_video_v1.yaml | 16 +++ 18 files changed, 347 insertions(+), 39 deletions(-) diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 534cdaa3..ff98223e 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -4890,6 +4890,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -5205,6 +5206,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -5520,6 +5522,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -5835,6 +5838,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -6150,6 +6154,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -6465,6 +6470,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -6780,6 +6786,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -7095,6 +7102,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -7410,6 +7418,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -7796,6 +7805,7 @@ components: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -8433,6 +8443,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts/{AccountSid}/Addresses.json pathType: list /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json: @@ -9108,6 +9120,8 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name + enumAliases: + permissions: permission parent: /Accounts.json pathType: list /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json: @@ -9152,6 +9166,8 @@ paths: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name + enumAliases: + permissions: permission parent: /Accounts.json pathType: instance /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json: @@ -10949,6 +10965,7 @@ paths: or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number. + format: endpoint type: string MachineDetection: description: 'Whether to detect if a human, answering machine, or @@ -11108,6 +11125,7 @@ paths: To: description: The phone number, SIP address, or client identifier to call. + format: endpoint type: string Trim: description: 'Whether to trim any leading and trailing silence from @@ -11118,6 +11136,7 @@ paths: description: TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored. Max 4000 characters. + format: twiml type: string Url: description: The absolute URL that returns the TwiML instructions @@ -13956,6 +13975,7 @@ paths: description: TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive + format: twiml type: string Url: description: The absolute URL that returns the TwiML instructions @@ -14367,6 +14387,7 @@ paths: must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint. + format: endpoint type: string JitterBufferSize: description: 'Jitter buffer size for the connecting participant. @@ -14490,6 +14511,7 @@ paths: format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified. + format: endpoint type: string WaitMethod: description: The HTTP method we should use to call `wait_url`. Can @@ -15235,6 +15257,8 @@ paths: defaultOutputProperties: - sid - friendly_name + enumAliases: + permissions: permission parent: /Accounts.json pathType: list /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json: @@ -15399,6 +15423,8 @@ paths: defaultOutputProperties: - sid - friendly_name + enumAliases: + permissions: permission parent: /Accounts.json pathType: instance /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json: @@ -15717,6 +15743,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts.json pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json: @@ -16028,6 +16056,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json: @@ -16338,6 +16368,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json: @@ -16648,6 +16680,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts/{AccountSid}/IncomingPhoneNumbers.json pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json: @@ -17337,6 +17371,8 @@ paths: - sid - phone_number - friendly_name + enumAliases: + address_requirements: address_requirement parent: /Accounts.json pathType: instance /2010-04-01/Accounts/{AccountSid}/Keys.json: @@ -23184,6 +23220,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -23533,6 +23570,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -23882,6 +23920,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -24231,6 +24270,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -24580,6 +24620,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -24929,6 +24970,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -25278,6 +25320,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -25627,6 +25670,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -25976,6 +26020,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -26347,6 +26392,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -26708,6 +26754,7 @@ paths: enum: - a2p-registration-fees - agent-conference + - amazon-polly - answering-machine-detection - authy-authentications - authy-calls-outbound @@ -26975,6 +27022,8 @@ paths: - friendly_name - usage_category - trigger_by + enumAliases: + trigger_by: trigger_field parent: /Accounts/{AccountSid}/Usage.json pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json: @@ -27116,6 +27165,8 @@ paths: - friendly_name - usage_category - trigger_by + enumAliases: + trigger_by: trigger_field parent: /Accounts/{AccountSid}/Usage.json pathType: instance /2010-04-01/Accounts/{Sid}.json: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index c04ba280..57146e6b 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -776,6 +776,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: list /v1/Credentials/{Sid}: delete: @@ -897,6 +899,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: instance /v1/Services: description: Top level scope for all chat resources @@ -1118,6 +1122,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: list /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: @@ -2084,6 +2090,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: instance /v1/Services/{ServiceSid}/Roles: @@ -2212,6 +2220,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: list /v1/Services/{ServiceSid}/Roles/{Sid}: @@ -2342,6 +2352,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: instance /v1/Services/{ServiceSid}/Users: @@ -2672,6 +2684,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: list /v1/Services/{Sid}: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index b5b657e6..530c0463 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -1030,6 +1030,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: list /v2/Credentials/{Sid}: delete: @@ -1148,6 +1150,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: instance /v2/Services: description: Top level scope for all chat resources @@ -1565,6 +1569,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: @@ -3037,6 +3043,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: instance /v2/Services/{ServiceSid}/Roles: @@ -3164,6 +3172,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: list /v2/Services/{ServiceSid}/Roles/{Sid}: @@ -3293,6 +3303,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: instance /v2/Services/{ServiceSid}/Users: @@ -3829,6 +3841,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: list /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: @@ -3991,6 +4005,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: instance /v2/Services/{Sid}: diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index 736c7ad7..bf2d7838 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -167,6 +167,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type pathType: instance servers: - url: https://chat.twilio.com diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 56180593..dc27a1c3 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -2643,6 +2643,8 @@ paths: - message_sid - status - date_created + enumAliases: + status: delivery_status parent: /Conversations/{ConversationSid}/Messages pathType: list /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: @@ -2698,6 +2700,8 @@ paths: - message_sid - status - date_created + enumAliases: + status: delivery_status parent: /Conversations/{ConversationSid}/Messages pathType: instance /v1/Conversations/{ConversationSid}/Messages/{Sid}: @@ -3702,6 +3706,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_type pathType: list /v1/Credentials/{Sid}: delete: @@ -3828,6 +3834,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_type pathType: instance /v1/ParticipantConversations: description: Participant Conversations resource represents a list of Conversations @@ -3905,6 +3913,8 @@ paths: - chat_service_sid - participant_sid - conversation_sid + enumAliases: + conversation_state: state pathType: list /v1/Roles: description: A Role resource represents a set of permissions granted to a user @@ -4011,6 +4021,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type pathType: list /v1/Roles/{Sid}: delete: @@ -4110,6 +4122,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type pathType: instance /v1/Services: description: A Service resource is a top-level conversation resource container @@ -5097,6 +5111,8 @@ paths: - message_sid - status - date_created + enumAliases: + status: delivery_status parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages pathType: list /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: @@ -5162,6 +5178,8 @@ paths: - message_sid - status - date_created + enumAliases: + status: delivery_status parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages pathType: instance /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}: @@ -6293,6 +6311,8 @@ paths: - chat_service_sid - participant_sid - conversation_sid + enumAliases: + conversation_state: state parent: /Services pathType: list /v1/Services/{ChatServiceSid}/Roles: @@ -6421,6 +6441,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: list /v1/Services/{ChatServiceSid}/Roles/{Sid}: @@ -6551,6 +6573,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: instance /v1/Services/{ChatServiceSid}/Users: @@ -6905,6 +6929,8 @@ paths: - chat_service_sid - friendly_name - date_created + enumAliases: + conversation_state: state parent: /Services/{ChatServiceSid}/Users pathType: list /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}: @@ -7057,6 +7083,8 @@ paths: - chat_service_sid - friendly_name - date_created + enumAliases: + conversation_state: state parent: /Services/{ChatServiceSid}/Users pathType: instance /v1/Services/{Sid}: @@ -7406,6 +7434,8 @@ paths: - chat_service_sid - friendly_name - date_created + enumAliases: + conversation_state: state parent: /Users pathType: list /v1/Users/{UserSid}/Conversations/{ConversationSid}: @@ -7528,6 +7558,8 @@ paths: - chat_service_sid - friendly_name - date_created + enumAliases: + conversation_state: state parent: /Users pathType: instance servers: diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index cc35c294..f992438c 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -133,6 +133,8 @@ paths: defaultOutputProperties: - sid - identity + enumAliases: + state: state_type pathType: instance servers: - url: https://frontline-api.twilio.com diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index a7c5eaf5..44b6ffa2 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -19,15 +19,35 @@ components: nullable: true type: boolean type: object - insights.v1.annotation: + insights.v1.call: + properties: + links: + format: uri-map + nullable: true + type: object + sid: + maxLength: 34 + minLength: 34 + nullable: true + pattern: ^CA[0-9a-fA-F]{32}$ + type: string + url: + format: uri + nullable: true + type: string + type: object + insights.v1.call.annotation: properties: account_sid: + description: Account SID. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string answered_by: + description: Indicates the answering entity as determined by Answering Machine + Detection. enum: - unknown_answered_by - human @@ -35,18 +55,22 @@ components: nullable: true type: string call_score: + description: Call Score nullable: true type: integer call_sid: + description: Call SID. maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string comment: + description: User comments nullable: true type: string connectivity_issue: + description: Indicates if the call had any connectivity issue enum: - unknown_connectivity_issue - no_connectivity_issue @@ -57,34 +81,21 @@ components: nullable: true type: string incident: + description: Call tag for incidents or support ticket nullable: true type: string quality_issues: + description: Indicates if the call had audio quality issues. items: type: string nullable: true type: array spam: + description: Call spam indicator nullable: true type: boolean url: - format: uri - nullable: true - type: string - type: object - insights.v1.call: - properties: - links: - format: uri-map - nullable: true - type: object - sid: - maxLength: 34 - minLength: 34 - nullable: true - pattern: ^CA[0-9a-fA-F]{32}$ - type: string - url: + description: The URL of this resource. format: uri nullable: true type: string @@ -190,6 +201,8 @@ components: nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string + annotation: + nullable: true attributes: nullable: true call_sid: @@ -1098,6 +1111,12 @@ paths: defaultOutputProperties: - conference_sid - account_sid + enumAliases: + end_reason: conference_end_reason + mixer_region: region + mixer_region_requested: region + status: conference_status + tags: tag pathType: list /v1/Conferences/{ConferenceSid}: description: 'TODO: Resource-level docs' @@ -1131,6 +1150,12 @@ paths: defaultOutputProperties: - conference_sid - account_sid + enumAliases: + end_reason: conference_end_reason + mixer_region: region + mixer_region_requested: region + status: conference_status + tags: tag pathType: instance /v1/Conferences/{ConferenceSid}/Participants: description: 'TODO: Resource-level docs' @@ -1218,6 +1243,9 @@ paths: - conference_sid - call_sid - account_sid + enumAliases: + conference_region: region + participant_region: region parent: /Conferences pathType: list /v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}: @@ -1275,6 +1303,9 @@ paths: - conference_sid - call_sid - account_sid + enumAliases: + conference_region: region + participant_region: region parent: /Conferences pathType: instance /v1/Video/Rooms: @@ -1376,6 +1407,9 @@ paths: defaultOutputProperties: - room_sid - create_time + enumAliases: + codecs: codec + media_region: twilio_realm pathType: list /v1/Video/Rooms/{RoomSid}: description: 'TODO: Resource-level docs' @@ -1406,6 +1440,9 @@ paths: defaultOutputProperties: - room_sid - create_time + enumAliases: + codecs: codec + media_region: twilio_realm pathType: instance /v1/Video/Rooms/{RoomSid}/Participants: description: 'TODO: Resource-level docs' @@ -1470,6 +1507,10 @@ paths: x-twilio: defaultOutputProperties: - participant_sid + enumAliases: + codecs: codec + media_region: twilio_realm + status: room_status parent: /Video/Rooms pathType: list /v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}: @@ -1506,6 +1547,10 @@ paths: x-twilio: defaultOutputProperties: - participant_sid + enumAliases: + codecs: codec + media_region: twilio_realm + status: room_status parent: /Video/Rooms pathType: instance /v1/Voice/Settings: @@ -1744,10 +1789,10 @@ paths: /v1/Voice/{CallSid}/Annotation: description: 'TODO: Resource-level docs' get: - description: '' + description: Fetch a specific Annotation. operationId: FetchAnnotation parameters: - - description: '' + - description: The unique SID identifier of the Call. in: path name: CallSid required: true @@ -1761,17 +1806,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/insights.v1.annotation' + $ref: '#/components/schemas/insights.v1.call.annotation' description: OK security: - accountSid_authToken: [] x-maturity: - - GA + - Beta post: - description: '' + description: Create/Update the annotation for the call operationId: UpdateAnnotation parameters: - - description: '' + - description: The unique string that Twilio created to identify this Call resource. + It always starts with a CA. in: path name: CallSid required: true @@ -1786,21 +1832,32 @@ paths: schema: properties: AnsweredBy: - description: '' + description: 'Which entity answered the call as determined by Answering + Machine Detection. Use this to provide feedback on Answering Machine + Detection accuracy. Possible enumerated values, one of: human, + machine. human indicates the call was answered by a person. machine + indicates the call was answered by an answering machine.' enum: - unknown_answered_by - human - machine type: string CallScore: - description: '' + description: 'Specify the call score. This is of type integer. Use + a range of 1-5 to indicate the call experience score, with the + following mapping as a reference for rating the call [5: Excellent, + 4: Good, 3 : Fair, 2 : Poor, 1: Bad].' nullable: true type: integer Comment: - description: '' + description: "Specify any comments pertaining to the call. This\ + \ of type string with a max limit of 100 characters. Twilio does\ + \ not treat this field as PII, so don\u2019t put any PII in here." type: string ConnectivityIssue: - description: '' + description: 'Specify if the call had any connectivity issues. Possible + enumerated values, one : no_connectivity_issue, invalid_number, + caller_id, dropped_call, number_reachability.' enum: - unknown_connectivity_issue - no_connectivity_issue @@ -1810,13 +1867,24 @@ paths: - number_reachability type: string Incident: - description: '' + description: "Associate this call with an incident or support ticket.\ + \ This is of type string with a max limit of 100 characters. Twilio\ + \ does not treat this field as PII, so don\u2019t put any PII\ + \ in here." type: string QualityIssues: - description: '' + description: 'Specify if the call had any subjective quality issues. + Possible values, one or more of: no_quality_issue, low_volume, + choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma + separated values to indicate multiple quality issues for the same + call' type: string Spam: - description: '' + description: 'Specify if the call was a spam call. Use this to provide + feedback on whether calls placed from your account were marked + as spam, or if inbound calls received by your account were unwanted + spam. Is of type Boolean: true, false. Use true if the call was + a spam call.' type: boolean title: UpdateAnnotationRequest type: object @@ -1825,18 +1893,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/insights.v1.annotation' + $ref: '#/components/schemas/insights.v1.call.annotation' description: OK security: - accountSid_authToken: [] x-maturity: - - GA + - Beta servers: - url: https://insights.twilio.com x-twilio: defaultOutputProperties: - call_sid - account_sid + parent: /Voice/{Sid} pathType: instance /v1/Voice/{CallSid}/Events: description: 'TODO: Resource-level docs' @@ -1919,6 +1988,8 @@ paths: - account_sid - edge - name + enumAliases: + edge: twilio_edge parent: /Voice/{Sid} pathType: list /v1/Voice/{CallSid}/Metrics: @@ -2012,6 +2083,9 @@ paths: - account_sid - edge - direction + enumAliases: + direction: stream_direction + edge: twilio_edge parent: /Voice/{Sid} pathType: list /v1/Voice/{CallSid}/Summary: @@ -2084,7 +2158,7 @@ paths: security: - accountSid_authToken: [] x-maturity: - - Preview + - GA servers: - url: https://insights.twilio.com x-twilio: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index 7b56b3bd..a2d7c47e 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -628,6 +628,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: list /v1/Credentials/{Sid}: delete: @@ -731,6 +733,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: instance /v1/Services: description: 'TODO: Resource-level docs' @@ -942,6 +946,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: list /v1/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: @@ -1829,6 +1835,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: instance /v1/Services/{ServiceSid}/Roles: @@ -1948,6 +1956,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: list /v1/Services/{ServiceSid}/Roles/{Sid}: @@ -2068,6 +2078,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: instance /v1/Services/{ServiceSid}/Users: @@ -2378,6 +2390,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: list /v1/Services/{Sid}: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index 9088c75a..c7209893 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -829,6 +829,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: list /v2/Credentials/{Sid}: delete: @@ -932,6 +934,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: instance /v2/Services: description: 'TODO: Resource-level docs' @@ -1323,6 +1327,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: list /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites: @@ -2631,6 +2637,8 @@ paths: - sid - unique_name - friendly_name + enumAliases: + type: channel_type parent: /Services pathType: instance /v2/Services/{ServiceSid}/Roles: @@ -2750,6 +2758,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: list /v2/Services/{ServiceSid}/Roles/{Sid}: @@ -2870,6 +2880,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: role_type parent: /Services pathType: instance /v2/Services/{ServiceSid}/Users: @@ -3374,6 +3386,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: list /v2/Services/{ServiceSid}/Users/{UserSid}/Channels/{ChannelSid}: @@ -3510,6 +3524,8 @@ paths: defaultOutputProperties: - channel_sid - status + enumAliases: + status: channel_status parent: /Services/{ServiceSid}/Users pathType: instance /v2/Services/{Sid}: diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index 98fdd31d..1b40fbbb 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -126,6 +126,8 @@ paths: - valid - validation_results - national_format + enumAliases: + validation_errors: validation_error pathType: instance servers: - url: https://lookups.twilio.com diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index 963280c8..0d5f9c73 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -84,10 +84,6 @@ components: nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string - bitrate: - description: The bitrate of the media - nullable: true - type: integer date_created: description: The ISO 8601 date and time in GMT when the resource was created format: date-time diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 5f1d4e6c..9090608a 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -468,6 +468,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: list /v1/Credentials/{Sid}: delete: @@ -584,6 +586,8 @@ paths: - sid - friendly_name - type + enumAliases: + type: push_service pathType: instance /v1/Services: description: 'TODO: Resource-level docs' diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 2a5ae842..f669f2d0 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -1383,6 +1383,9 @@ paths: - sid - type - data + enumAliases: + inbound_resource_status: resource_status + outbound_resource_status: resource_status parent: /Services/{ServiceSid}/Sessions pathType: list /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: @@ -1480,6 +1483,9 @@ paths: - sid - type - data + enumAliases: + inbound_resource_status: resource_status + outbound_resource_status: resource_status parent: /Services/{ServiceSid}/Sessions pathType: instance /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants: @@ -1793,6 +1799,9 @@ paths: - sid - type - data + enumAliases: + inbound_resource_status: resource_status + outbound_resource_status: resource_status parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants pathType: list /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}: @@ -1859,6 +1868,9 @@ paths: - sid - type - data + enumAliases: + inbound_resource_status: resource_status + outbound_resource_status: resource_status parent: /Services/{ServiceSid}/Sessions/{SessionSid}/Participants pathType: instance /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 7cd7a830..2a543f64 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -1968,6 +1968,8 @@ paths: - start_time - end_time - period_type + enumAliases: + period_type: bp_type parent: /Sims pathType: list /v1/SmsCommands: diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 68e70a9b..10cf3b0a 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1803,6 +1803,8 @@ paths: - sid - friendly_name - prioritize_queue_order + enumAliases: + prioritize_queue_order: queue_order pathType: list /v1/Workspaces/{Sid}: delete: @@ -1941,6 +1943,8 @@ paths: - sid - friendly_name - prioritize_queue_order + enumAliases: + prioritize_queue_order: queue_order pathType: instance /v1/Workspaces/{WorkspaceSid}/Activities: description: 'TODO: Resource-level docs' @@ -3659,6 +3663,8 @@ paths: - assignment_status - priority - reason + enumAliases: + assignment_status: status parent: /Workspaces pathType: list /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}: @@ -3820,6 +3826,8 @@ paths: - assignment_status - priority - reason + enumAliases: + assignment_status: status parent: /Workspaces pathType: instance /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations: @@ -3917,6 +3925,8 @@ paths: - reservation_status - worker_name - worker_sid + enumAliases: + reservation_status: status parent: /Workspaces/{WorkspaceSid}/Tasks pathType: list /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}: @@ -4347,6 +4357,8 @@ paths: - reservation_status - worker_name - worker_sid + enumAliases: + reservation_status: status parent: /Workspaces/{WorkspaceSid}/Tasks pathType: instance /v1/Workspaces/{WorkspaceSid}/Workers: @@ -5139,6 +5151,8 @@ paths: - sid - reservation_status - date_created + enumAliases: + reservation_status: status parent: /Workspaces/{WorkspaceSid}/Workers pathType: list /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}: @@ -5559,6 +5573,8 @@ paths: - sid - reservation_status - date_created + enumAliases: + reservation_status: status parent: /Workspaces/{WorkspaceSid}/Workers pathType: instance /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics: diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index fae12322..43e9d1e4 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -615,6 +615,8 @@ paths: - sid - friendly_name - domain_name + enumAliases: + transfer_mode: transfer_setting pathType: list /v1/Trunks/{Sid}: delete: @@ -764,6 +766,8 @@ paths: - sid - friendly_name - domain_name + enumAliases: + transfer_mode: transfer_setting pathType: instance /v1/Trunks/{TrunkSid}/CredentialLists: description: List of credentials for accessing a trunk @@ -1523,6 +1527,8 @@ paths: - sid - friendly_name - phone_number + enumAliases: + address_requirements: address_requirement parent: /Trunks pathType: list /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}: @@ -1598,6 +1604,8 @@ paths: - sid - friendly_name - phone_number + enumAliases: + address_requirements: address_requirement parent: /Trunks pathType: instance /v1/Trunks/{TrunkSid}/Recording: @@ -1681,6 +1689,9 @@ paths: defaultOutputProperties: - mode - trim + enumAliases: + mode: recording_mode + trim: recording_trim parent: /Trunks pathType: instance servers: diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 72b15b25..1d6771ce 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -1159,6 +1159,8 @@ paths: - date_updated - conversion_status - channel + enumAliases: + channel: channels pathType: list /v2/Attempts/Summary: description: 'TODO: Resource-level docs' @@ -1170,7 +1172,7 @@ paths: - description: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation. in: query - name: VerifyServiceSid + name: ServiceSid schema: maxLength: 34 minLength: 34 @@ -1273,6 +1275,8 @@ paths: - date_updated - conversion_status - channel + enumAliases: + channel: channels pathType: instance /v2/Forms/{FormType}: description: 'TODO: Resource-level docs' @@ -1304,6 +1308,8 @@ paths: x-twilio: defaultOutputProperties: - form_type + enumAliases: + form_type: form_types pathType: instance /v2/Services: description: 'TODO: Resource-level docs' @@ -1552,6 +1558,8 @@ paths: - token - ttl - date_created + enumAliases: + factor_type: factor_types parent: /Services pathType: list /v2/Services/{ServiceSid}/AccessTokens/{Sid}: @@ -1602,6 +1610,8 @@ paths: - token - ttl - date_created + enumAliases: + factor_type: factor_types parent: /Services pathType: instance /v2/Services/{ServiceSid}/Entities: @@ -1972,6 +1982,10 @@ paths: - status - responded_reason - date_created + enumAliases: + factor_type: factor_types + responded_reason: challenge_reasons + status: challenge_statuses parent: /Services/{ServiceSid}/Entities pathType: list /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications: @@ -2155,6 +2169,10 @@ paths: - status - responded_reason - date_created + enumAliases: + factor_type: factor_types + responded_reason: challenge_reasons + status: challenge_statuses parent: /Services/{ServiceSid}/Entities pathType: instance /v2/Services/{ServiceSid}/Entities/{Identity}/Factors: @@ -2393,6 +2411,9 @@ paths: - friendly_name - status - factor_type + enumAliases: + factor_type: factor_types + status: factor_statuses parent: /Services/{ServiceSid}/Entities pathType: list /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}: @@ -2580,6 +2601,9 @@ paths: - friendly_name - status - factor_type + enumAliases: + factor_type: factor_types + status: factor_statuses parent: /Services/{ServiceSid}/Entities pathType: instance /v2/Services/{ServiceSid}/MessagingConfigurations: @@ -3792,6 +3816,8 @@ paths: - webhook_method - status - date_created + enumAliases: + webhook_method: methods parent: /Services pathType: list /v2/Services/{ServiceSid}/Webhooks/{Sid}: @@ -3942,6 +3968,8 @@ paths: - webhook_method - status - date_created + enumAliases: + webhook_method: methods parent: /Services pathType: instance /v2/Services/{Sid}: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 021db8af..9aa72fd4 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -1876,6 +1876,8 @@ paths: - type - duration - codec + enumAliases: + container_format: format pathType: list /v1/Recordings/{Sid}: delete: @@ -1933,6 +1935,8 @@ paths: - type - duration - codec + enumAliases: + container_format: format pathType: instance /v1/Rooms: description: Video rooms with one or more participants @@ -2135,6 +2139,10 @@ paths: - sid - unique_name - status + enumAliases: + status: room_status + type: room_type + video_codecs: video_codec pathType: list /v1/Rooms/{RoomSid}/Participants: description: Participants in video rooms @@ -2813,6 +2821,8 @@ paths: - type - duration - codec + enumAliases: + container_format: format parent: /Rooms pathType: list /v1/Rooms/{RoomSid}/Recordings/{Sid}: @@ -2890,6 +2900,8 @@ paths: - type - duration - codec + enumAliases: + container_format: format parent: /Rooms pathType: instance /v1/Rooms/{Sid}: @@ -2960,6 +2972,10 @@ paths: - sid - unique_name - status + enumAliases: + status: room_status + type: room_type + video_codecs: video_codec pathType: instance servers: - url: https://video.twilio.com