twilio-ruby 6.1.0 → 6.2.0

data/lib/twilio-ruby/rest/insights/v1/call_summaries.rb

@@ -34,29 +34,29 @@ module Twilio
                     # Lists CallSummariesInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
-                    # @param [String] from 
-                    # @param [String] to 
-                    # @param [String] from_carrier 
-                    # @param [String] to_carrier 
-                    # @param [String] from_country_code 
-                    # @param [String] to_country_code 
-                    # @param [Boolean] branded 
-                    # @param [Boolean] verified_caller 
-                    # @param [Boolean] has_tag 
-                    # @param [String] start_time 
-                    # @param [String] end_time 
-                    # @param [String] call_type 
-                    # @param [String] call_state 
-                    # @param [String] direction 
-                    # @param [ProcessingStateRequest] processing_state 
-                    # @param [SortBy] sort_by 
-                    # @param [String] subaccount 
-                    # @param [Boolean] abnormal_session 
-                    # @param [AnsweredBy] answered_by 
-                    # @param [String] connectivity_issue 
-                    # @param [String] quality_issue 
-                    # @param [Boolean] spam 
-                    # @param [String] call_score 
+                    # @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] from_carrier An origination carrier.
+                    # @param [String] to_carrier A destination carrier.
+                    # @param [String] from_country_code A source country code based on phone number in From.
+                    # @param [String] to_country_code A destination country code. Based on phone number in To.
+                    # @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
+                    # @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
+                    # @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
+                    # @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
+                    # @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
+                    # @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
+                    # @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
+                    # @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
+                    # @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
+                    # @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
+                    # @param [String] subaccount A unique SID identifier of a Subaccount.
+                    # @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
+                    # @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
+                    # @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
+                    # @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
+                    # @param [Boolean] spam A boolean flag indicating spam calls.
+                    # @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
                     # @param [Integer] limit Upper limit for the number of records to return. stream()
                     #    guarantees to never return more than limit.  Default is no limit
                     # @param [Integer] page_size Number of records to fetch per request, when
@@ -98,29 +98,29 @@ module Twilio
                     # Streams Instance records from the API as an Enumerable.
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
-                    # @param [String] from 
-                    # @param [String] to 
-                    # @param [String] from_carrier 
-                    # @param [String] to_carrier 
-                    # @param [String] from_country_code 
-                    # @param [String] to_country_code 
-                    # @param [Boolean] branded 
-                    # @param [Boolean] verified_caller 
-                    # @param [Boolean] has_tag 
-                    # @param [String] start_time 
-                    # @param [String] end_time 
-                    # @param [String] call_type 
-                    # @param [String] call_state 
-                    # @param [String] direction 
-                    # @param [ProcessingStateRequest] processing_state 
-                    # @param [SortBy] sort_by 
-                    # @param [String] subaccount 
-                    # @param [Boolean] abnormal_session 
-                    # @param [AnsweredBy] answered_by 
-                    # @param [String] connectivity_issue 
-                    # @param [String] quality_issue 
-                    # @param [Boolean] spam 
-                    # @param [String] call_score 
+                    # @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] from_carrier An origination carrier.
+                    # @param [String] to_carrier A destination carrier.
+                    # @param [String] from_country_code A source country code based on phone number in From.
+                    # @param [String] to_country_code A destination country code. Based on phone number in To.
+                    # @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
+                    # @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
+                    # @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
+                    # @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
+                    # @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
+                    # @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
+                    # @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
+                    # @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
+                    # @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
+                    # @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
+                    # @param [String] subaccount A unique SID identifier of a Subaccount.
+                    # @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
+                    # @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
+                    # @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
+                    # @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
+                    # @param [Boolean] spam A boolean flag indicating spam calls.
+                    # @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
                     # @param [Integer] limit Upper limit for the number of records to return. stream()
                     #    guarantees to never return more than limit.  Default is no limit
                     # @param [Integer] page_size Number of records to fetch per request, when
@@ -177,29 +177,29 @@ module Twilio
                     ##
                     # Retrieve a single page of CallSummariesInstance records from the API.
                     # Request is executed immediately.
-                    # @param [String] from 
-                    # @param [String] to 
-                    # @param [String] from_carrier 
-                    # @param [String] to_carrier 
-                    # @param [String] from_country_code 
-                    # @param [String] to_country_code 
-                    # @param [Boolean] branded 
-                    # @param [Boolean] verified_caller 
-                    # @param [Boolean] has_tag 
-                    # @param [String] start_time 
-                    # @param [String] end_time 
-                    # @param [String] call_type 
-                    # @param [String] call_state 
-                    # @param [String] direction 
-                    # @param [ProcessingStateRequest] processing_state 
-                    # @param [SortBy] sort_by 
-                    # @param [String] subaccount 
-                    # @param [Boolean] abnormal_session 
-                    # @param [AnsweredBy] answered_by 
-                    # @param [String] connectivity_issue 
-                    # @param [String] quality_issue 
-                    # @param [Boolean] spam 
-                    # @param [String] call_score 
+                    # @param [String] from A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] to A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
+                    # @param [String] from_carrier An origination carrier.
+                    # @param [String] to_carrier A destination carrier.
+                    # @param [String] from_country_code A source country code based on phone number in From.
+                    # @param [String] to_country_code A destination country code. Based on phone number in To.
+                    # @param [Boolean] branded A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.
+                    # @param [Boolean] verified_caller A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.
+                    # @param [Boolean] has_tag A boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
+                    # @param [String] start_time A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
+                    # @param [String] end_time An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
+                    # @param [String] call_type A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
+                    # @param [String] call_state A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
+                    # @param [String] direction A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
+                    # @param [ProcessingStateRequest] processing_state A Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
+                    # @param [SortBy] sort_by A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
+                    # @param [String] subaccount A unique SID identifier of a Subaccount.
+                    # @param [Boolean] abnormal_session A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
+                    # @param [AnsweredBy] answered_by An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
+                    # @param [String] connectivity_issue A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
+                    # @param [String] quality_issue A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
+                    # @param [Boolean] spam A boolean flag indicating spam calls.
+                    # @param [String] call_score A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
                     # @param [String] page_token PageToken provided by the API
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
@@ -355,13 +355,13 @@ module Twilio
 
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Account.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Call.
                     def call_sid
                         @properties['call_sid']
                     end
@@ -391,97 +391,97 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Time] 
+                    # @return [Time] The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
                     def created_time
                         @properties['created_time']
                     end
                     
                     ##
-                    # @return [Time] 
+                    # @return [Time] The time at which the Call was started, given in ISO 8601 format.
                     def start_time
                         @properties['start_time']
                     end
                     
                     ##
-                    # @return [Time] 
+                    # @return [Time] The time at which the Call was ended, given in ISO 8601 format.
                     def end_time
                         @properties['end_time']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Duration between when the call was initiated and the call was ended
                     def duration
                         @properties['duration']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Duration between when the call was answered and when it ended
                     def connect_duration
                         @properties['connect_duration']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] The calling party.
                     def from
                         @properties['from']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] The called party.
                     def to
                         @properties['to']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a PSTN call.
                     def carrier_edge
                         @properties['carrier_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a Client call.
                     def client_edge
                         @properties['client_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains metrics and properties for the SDK sensor library for Client calls.
                     def sdk_edge
                         @properties['sdk_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
                     def sip_edge
                         @properties['sip_edge']
                     end
                     
                     ##
-                    # @return [Array<String>] 
+                    # @return [Array<String>] Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
                     def tags
                         @properties['tags']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The URL of this resource.
                     def url
                         @properties['url']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Attributes capturing call-flow-specific details.
                     def attributes
                         @properties['attributes']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains edge-agnostic call-level details.
                     def properties
                         @properties['properties']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Contains trusted communications details including Branded Call and verified caller ID.
                     def trust
                         @properties['trust']
                     end

data/lib/twilio-ruby/rest/insights/v1/setting.rb

@@ -55,7 +55,7 @@ module Twilio
                     end
                     ##
                     # Fetch the SettingInstance
-                    # @param [String] subaccount_sid 
+                    # @param [String] subaccount_sid The unique SID identifier of the Subaccount.
                     # @return [SettingInstance] Fetched SettingInstance
                     def fetch(
                         subaccount_sid: :unset
@@ -73,9 +73,9 @@ module Twilio
 
                     ##
                     # Update the SettingInstance
-                    # @param [Boolean] advanced_features 
-                    # @param [Boolean] voice_trace 
-                    # @param [String] subaccount_sid 
+                    # @param [Boolean] advanced_features A boolean flag to enable Advanced Features for Voice Insights.
+                    # @param [Boolean] voice_trace A boolean flag to enable Voice Trace.
+                    # @param [String] subaccount_sid The unique SID identifier of the Subaccount.
                     # @return [SettingInstance] Updated SettingInstance
                     def update(
                         advanced_features: :unset, 
@@ -178,32 +178,32 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Account.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [Boolean] 
+                    # @return [Boolean] A boolean flag indicating whether Advanced Features for Voice Insights are enabled.
                     def advanced_features
                         @properties['advanced_features']
                     end
                     
                     ##
-                    # @return [Boolean] 
+                    # @return [Boolean] A boolean flag indicating whether Voice Trace is enabled.
                     def voice_trace
                         @properties['voice_trace']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The URL of this resource.
                     def url
                         @properties['url']
                     end
                     
                     ##
                     # Fetch the SettingInstance
-                    # @param [String] subaccount_sid 
+                    # @param [String] subaccount_sid The unique SID identifier of the Subaccount.
                     # @return [SettingInstance] Fetched SettingInstance
                     def fetch(
                         subaccount_sid: :unset
@@ -216,9 +216,9 @@ module Twilio
 
                     ##
                     # Update the SettingInstance
-                    # @param [Boolean] advanced_features 
-                    # @param [Boolean] voice_trace 
-                    # @param [String] subaccount_sid 
+                    # @param [Boolean] advanced_features A boolean flag to enable Advanced Features for Voice Insights.
+                    # @param [Boolean] voice_trace A boolean flag to enable Voice Trace.
+                    # @param [String] subaccount_sid The unique SID identifier of the Subaccount.
                     # @return [SettingInstance] Updated SettingInstance
                     def update(
                         advanced_features: :unset, 

data/lib/twilio-ruby/rest/lookups/v2/phone_number.rb

@@ -58,7 +58,7 @@ module Twilio
                     end
                     ##
                     # Fetch the PhoneNumberInstance
-                    # @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.
+                    # @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match, reassigned_number.
                     # @param [String] country_code The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.
                     # @param [String] first_name User’s first name. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] last_name User’s last name. This query parameter is only used (optionally) for identity_match package requests.
@@ -70,6 +70,7 @@ module Twilio
                     # @param [String] address_country_code User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] national_id User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
                     # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
                     def fetch(
                         fields: :unset, 
@@ -83,7 +84,8 @@ module Twilio
                         postal_code: :unset, 
                         address_country_code: :unset, 
                         national_id: :unset, 
-                        date_of_birth: :unset
+                        date_of_birth: :unset, 
+                        last_verified_date: :unset
                     )
 
                         params = Twilio::Values.of({
@@ -99,6 +101,7 @@ module Twilio
                             'AddressCountryCode' => address_country_code,
                             'NationalId' => national_id,
                             'DateOfBirth' => date_of_birth,
+                            'LastVerifiedDate' => last_verified_date,
                         })
                         payload = @version.fetch('GET', @uri, params: params)
                         PhoneNumberInstance.new(
@@ -179,6 +182,7 @@ module Twilio
                             'live_activity' => payload['live_activity'],
                             'line_type_intelligence' => payload['line_type_intelligence'],
                             'identity_match' => payload['identity_match'],
+                            'reassigned_number' => payload['reassigned_number'],
                             'sms_pumping_risk' => payload['sms_pumping_risk'],
                             'url' => payload['url'],
                         }
@@ -271,6 +275,12 @@ module Twilio
                         @properties['identity_match']
                     end
                     
+                    ##
+                    # @return [Hash] An object that contains reassigned number information. Reassigned Numbers will return a phone number's reassignment status given a phone number and date
+                    def reassigned_number
+                        @properties['reassigned_number']
+                    end
+                    
                     ##
                     # @return [Hash] An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates.
                     def sms_pumping_risk
@@ -285,7 +295,7 @@ module Twilio
                     
                     ##
                     # Fetch the PhoneNumberInstance
-                    # @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.
+                    # @param [String] fields A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match, reassigned_number.
                     # @param [String] country_code The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.
                     # @param [String] first_name User’s first name. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] last_name User’s last name. This query parameter is only used (optionally) for identity_match package requests.
@@ -297,6 +307,7 @@ module Twilio
                     # @param [String] address_country_code User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] national_id User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.
                     # @param [String] date_of_birth User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.
+                    # @param [String] last_verified_date The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.
                     # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
                     def fetch(
                         fields: :unset, 
@@ -310,7 +321,8 @@ module Twilio
                         postal_code: :unset, 
                         address_country_code: :unset, 
                         national_id: :unset, 
-                        date_of_birth: :unset
+                        date_of_birth: :unset, 
+                        last_verified_date: :unset
                     )
 
                         context.fetch(
@@ -326,6 +338,7 @@ module Twilio
                             address_country_code: address_country_code, 
                             national_id: national_id, 
                             date_of_birth: date_of_birth, 
+                            last_verified_date: last_verified_date, 
                         )
                     end