twilio-ruby 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c6b1c3502cddca5945482d45e5a8363b72e858f
-  data.tar.gz: 83a05654e46726cc1f5c8a34b43664894b6f88e6
+  metadata.gz: 0c3b2576c210dd02fdc994c2570cd5cc396180b0
+  data.tar.gz: e9ebd236423454df6e3149ef240763f5c91f07c3
 SHA512:
-  metadata.gz: 4ff45689c5dc58765000a2d10fbc8af9a6a8283e3448114e39033db16e5a0a14130e78ebdbcd06b095ce965e121fa477c0bcb87e16bbe796b53c6844db121eb9
-  data.tar.gz: c83c6a846d766369d3d897d7d6ae4574c3b75fb3f6eae9f296cb920401911deb443062d34c218e680960548218c2b08c7058237a61967dc75dc02d81c321c163
+  metadata.gz: 5ed4d0dd63460c5b46894191c548dd09de759e3e4f0970c43b6f7bb2cd547847e3ee2e8034d6eedcc1cddb1dfe62689821f99626604acbfe1c5e026560a30a09
+  data.tar.gz: ae8e99cf0b83ee0f73c404f179edd80c91ade18bbf1694adf72f5ef1a91c1369cff7a0f76f69e5a269f52b519457cc65429996e4a4ae6087073ade8c3eb5fe09

data/CHANGES.md

@@ -1,6 +1,21 @@
 twilio-ruby changelog
 ===================== 
 
+[2023-06-28] Version 6.2.0
+--------------------------
+**Library - Fix**
+- [PR #665](https://github.com/twilio/twilio-ruby/pull/665): #663 local jump error due to lack of block passing for recording list. Thanks to [@JYorston](https://github.com/JYorston)!
+
+**Lookups**
+- Add `reassigned_number` package to the lookup response
+
+**Numbers**
+- Add hosted_number_order under version `/v2`.
+- Update properties in Porting and Bulk Porting APIs. **(breaking change)**
+- Added bulk Portability API under version `/v1`.
+- Added Portability API under version `/v1`.
+
+
 [2023-06-15] Version 6.1.0
 --------------------------
 **Api**

data/README.md

@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 6.1.0'
+gem 'twilio-ruby', '~> 6.2.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 6.1.0
+gem install twilio-ruby -v 6.2.0
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -75,11 +75,11 @@ module Twilio
                     # Update the AnnotationInstance
                     # @param [AnsweredBy] answered_by 
                     # @param [ConnectivityIssue] connectivity_issue 
-                    # @param [String] quality_issues 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
-                    # @param [Boolean] spam 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.
+                    # @param [String] quality_issues 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.
+                    # @param [Boolean] spam A boolean flag to indicate 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. Use `true` if the call was a spam call.
                     # @param [String] call_score 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].
-                    # @param [String] comment 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’t put any PII in here.
-                    # @param [String] incident 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’t put any PII in here.
+                    # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
+                    # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
                     # @return [AnnotationInstance] Updated AnnotationInstance
                     def update(
                         answered_by: :unset, 
@@ -221,31 +221,31 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Array<String>] 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
+                    # @return [Array<String>] Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.
                     def quality_issues
                         @properties['quality_issues']
                     end
                     
                     ##
-                    # @return [Boolean] 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.
+                    # @return [Boolean] Specifies 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.
                     def spam
                         @properties['spam']
                     end
                     
                     ##
-                    # @return [String] 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].
+                    # @return [String] Specifies the Call Score, if available. 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].
                     def call_score
                         @properties['call_score']
                     end
                     
                     ##
-                    # @return [String] 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’t put any PII in here.
+                    # @return [String] Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.
                     def comment
                         @properties['comment']
                     end
                     
                     ##
-                    # @return [String] 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’t put any PII in here.
+                    # @return [String] Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
                     def incident
                         @properties['incident']
                     end
@@ -268,11 +268,11 @@ module Twilio
                     # Update the AnnotationInstance
                     # @param [AnsweredBy] answered_by 
                     # @param [ConnectivityIssue] connectivity_issue 
-                    # @param [String] quality_issues 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
-                    # @param [Boolean] spam 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.
+                    # @param [String] quality_issues 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.
+                    # @param [Boolean] spam A boolean flag to indicate 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. Use `true` if the call was a spam call.
                     # @param [String] call_score 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].
-                    # @param [String] comment 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’t put any PII in here.
-                    # @param [String] incident 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’t put any PII in here.
+                    # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
+                    # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
                     # @return [AnnotationInstance] Updated AnnotationInstance
                     def update(
                         answered_by: :unset, 

data/lib/twilio-ruby/rest/insights/v1/call/call_summary.rb

@@ -45,7 +45,7 @@ module Twilio
                     ##
                     # Initialize the CallSummaryContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] call_sid 
+                    # @param [String] call_sid The unique SID identifier of the Call.
                     # @return [CallSummaryContext] CallSummaryContext
                     def initialize(version, call_sid)
                         super(version)
@@ -58,7 +58,7 @@ module Twilio
                     end
                     ##
                     # Fetch the CallSummaryInstance
-                    # @param [ProcessingState] processing_state 
+                    # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
                     # @return [CallSummaryInstance] Fetched CallSummaryInstance
                     def fetch(
                         processing_state: :unset
@@ -176,13 +176,13 @@ module Twilio
                     end
                     
                     ##
-                    # @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
@@ -212,110 +212,110 @@ 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
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.
                     def annotation
                         @properties['annotation']
                     end
                     
                     ##
                     # Fetch the CallSummaryInstance
-                    # @param [ProcessingState] processing_state 
+                    # @param [ProcessingState] processing_state The Processing State of this Call Summary. One of `complete`, `partial` or `all`.
                     # @return [CallSummaryInstance] Fetched CallSummaryInstance
                     def fetch(
                         processing_state: :unset

data/lib/twilio-ruby/rest/insights/v1/call/event.rb

@@ -36,7 +36,7 @@ module Twilio
                     # Lists EventInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
-                    # @param [TwilioEdge] edge 
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
                     # @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
@@ -56,7 +56,7 @@ 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 [TwilioEdge] edge 
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
                     # @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
@@ -91,7 +91,7 @@ module Twilio
                     ##
                     # Retrieve a single page of EventInstance records from the API.
                     # Request is executed immediately.
-                    # @param [TwilioEdge] edge 
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
                     # @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
@@ -191,19 +191,19 @@ module Twilio
 
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Event time.
                     def timestamp
                         @properties['timestamp']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Call.
                     def call_sid
                         @properties['call_sid']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Account.
                     def account_sid
                         @properties['account_sid']
                     end
@@ -215,7 +215,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Event group.
                     def group
                         @properties['group']
                     end
@@ -227,31 +227,31 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Event name.
                     def name
                         @properties['name']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.
                     def carrier_edge
                         @properties['carrier_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.
                     def sip_edge
                         @properties['sip_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
                     def sdk_edge
                         @properties['sdk_edge']
                     end
                     
                     ##
-                    # @return [Hash] 
+                    # @return [Hash] Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.
                     def client_edge
                         @properties['client_edge']
                     end

data/lib/twilio-ruby/rest/insights/v1/call/metric.rb

@@ -36,8 +36,8 @@ module Twilio
                     # Lists MetricInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
-                    # @param [TwilioEdge] edge 
-                    # @param [StreamDirection] direction 
+                    # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
                     # @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
@@ -58,8 +58,8 @@ 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 [TwilioEdge] edge 
-                    # @param [StreamDirection] direction 
+                    # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
                     # @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
@@ -95,8 +95,8 @@ module Twilio
                     ##
                     # Retrieve a single page of MetricInstance records from the API.
                     # Request is executed immediately.
-                    # @param [TwilioEdge] edge 
-                    # @param [StreamDirection] direction 
+                    # @param [TwilioEdge] edge The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @param [StreamDirection] direction The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
                     # @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
@@ -196,19 +196,19 @@ module Twilio
 
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.
                     def timestamp
                         @properties['timestamp']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Call.
                     def call_sid
                         @properties['call_sid']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] The unique SID identifier of the Account.
                     def account_sid
                         @properties['account_sid']
                     end
@@ -226,25 +226,25 @@ module Twilio
                     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 SIP Interface or Trunking call.
                     def sip_edge
                         @properties['sip_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 Client call.
                     def client_edge
                         @properties['client_edge']
                     end