twilio-ruby 5.45.0 → 5.60.0

data/README.md

@@ -1,6 +1,6 @@
 # twilio-ruby
 
-[![Build Status](https://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Build Status](https://app.travis-ci.com/twilio/twilio-ruby.svg?branch=main)][travis]
 [![Gem Version](https://img.shields.io/gem/v/twilio-ruby.svg)](https://rubygems.org/gems/twilio-ruby)
 [![Learn with TwilioQuest](https://img.shields.io/static/v1?label=TwilioQuest&message=Learn%20to%20contribute%21&color=F22F46&labelColor=1f243c&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAASFBMVEUAAAAZGRkcHBwjIyMoKCgAAABgYGBoaGiAgICMjIyzs7PJycnMzMzNzc3UoBfd3d3m5ubqrhfrMEDu7u739/f4vSb/3AD///9tbdyEAAAABXRSTlMAAAAAAMJrBrEAAAKoSURBVHgB7ZrRcuI6EESdyxXGYoNFvMD//+l2bSszRgyUYpFAsXOeiJGmj4NkuWx1Qeh+Ekl9DgEXOBwOx+Px5xyQhDykfgq4wG63MxxaR4ddIkg6Ul3g84vCIcjPBA5gmUMeXESrlukuoK33+33uID8TWeLAdOWsKpJYzwVMB7bOzYSGOciyUlXSn0/ABXTosJ1M1SbypZ4O4MbZuIDMU02PMbauhhHMHXbmebmALIiEbbbbbUrpF1gwE9kFfRNAJaP+FQEXCCTGyJ4ngDrjOFo3jEL5JdqjF/pueR4cCeCGgAtwmuRS6gDwaRiGvu+DMFwSBLTE3+jF8JyuV1okPZ+AC4hDFhCHyHQjdjPHUKFDlHSJkHQXMB3KpSwXNGJPcwwTdZiXlRN0gSp0zpWxNtM0beYE0nRH6QIbO7rawwXaBYz0j78gxjokDuv12gVeUuBD0MDi0OQCLvDaAho4juP1Q/jkAncXqIcCfd+7gAu4QLMACCLxpRsSuQh0igu0C9Svhi7weAGZg50L3IE3cai4IfkNZAC8dfdhsUD3CgKBVC9JE5ABAFzg4QL/taYPAAWrHdYcgfLaIgAXWJ7OV38n1LEF8tt2TH29E+QAoDoO5Ve/LtCQDmKM9kPbvCEBApK+IXzbcSJ0cIGF6e8gpcRhUDogWZ8JnaWjPXc/fNnBBUKRngiHgTUSivSzDRDgHZQOLvBQgf8rRt+VdBUUhwkU6VpJ+xcOwQUqZr+mR0kvBUgv6cB4+37hQAkXqE8PwGisGhJtN4xAHMzrsgvI7rccXqSvKh6jltGlrOHA3Xk1At3LC4QiPdX9/0ndHpGVvTjR4bZA1ypAKgVcwE5vx74ulwIugDt8e/X7JgfkucBMIAr26ndnB4UCLnDOqvteQsHlgX9N4A+c4cW3DXSPbwAAAABJRU5ErkJggg==)](https://twil.io/learn-open-source)
 
@@ -24,6 +24,7 @@ This library supports the following Ruby implementations:
 * Ruby 2.5
 * Ruby 2.6
 * Ruby 2.7
+* Ruby 3.0
 
 ### Migrating from 4.x
 
@@ -34,13 +35,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.45.0'
+gem 'twilio-ruby', '~> 5.60.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.45.0
+gem install twilio-ruby -v 5.60.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -66,6 +67,20 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
+### Use An API Key
+
+```ruby
+require 'twilio-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
+api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Twilio REST API using an API Key
+@client = Twilio::REST::Client.new api_key_sid, api_key_secret, account_sid
+```
+
 ### Specify a Region and/or Edge
 
 To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
@@ -81,6 +96,8 @@ To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/doc
 @client.edge = 'sydney'
 ```
 
+This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
+
 ### Enable Debug logging
 
 In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
@@ -97,8 +114,6 @@ myLogger.level = Logger::DEBUG
 @client.logger = myLogger
 ```
 
-This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
-
 ### Make a Call
 
 ```ruby
@@ -143,6 +158,14 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
 To use a custom HTTP client with this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/custom-http-clients).
 
+To apply customizations such as middleware, you can use the `configure_connection` method like so:
+
+```ruby
+@client.http_client.configure_connection do |faraday|
+  faraday.use SomeMiddleware
+end
+```
+
 ### Handling Errors
 
 ```ruby
@@ -234,7 +257,7 @@ If you've instead found a bug in the library or would like new features added, g
 [bundler]: https://bundler.io
 [rubygems]: https://rubygems.org
 [gem]: https://rubygems.org/gems/twilio
-[travis]: https://travis-ci.org/twilio/twilio-ruby
+[travis]: https://travis-ci.com/twilio/twilio-ruby
 [upgrade]: https://github.com/twilio/twilio-ruby/wiki/Ruby-Version-5.x-Upgrade-Guide
 [issues]: https://github.com/twilio/twilio-ruby/issues
 [faraday]: https://github.com/lostisland/faraday

data/examples/examples.rb

@@ -69,7 +69,7 @@ puts @client.messages('SMXXXXXXXX').fetch.body
 @client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
-  media_urls: 'http://example.com/media.png'
+  media_url: 'http://example.com/media.png'
 )
 
 ################ PHONE NUMBERS ################

data/lib/twilio-ruby/http/http_client.rb

@@ -16,25 +16,37 @@ module Twilio
         @ssl_ca_file = ssl_ca_file
         @timeout = timeout
         @adapter = Faraday.default_adapter
+        @configure_connection_blocks = []
+      end
+
+      def configure_connection(&block)
+        raise ArgumentError, "#{__method__} must be given a block!" unless block_given?
+
+        @configure_connection_blocks << block
+        nil
       end
 
       def _request(request)
         @connection = Faraday.new(url: request.host + ':' + request.port.to_s, ssl: { verify: true }) do |f|
           f.options.params_encoder = Faraday::FlatParamsEncoder
           f.request :url_encoded
-          f.adapter @adapter
           f.headers = request.headers
-          f.basic_auth(request.auth[0], request.auth[1])
+          f.request(:basic_auth, request.auth[0], request.auth[1])
           f.proxy = "#{@proxy_prot}://#{@proxy_auth}#{@proxy_path}" if @proxy_prot && @proxy_path
           f.options.open_timeout = request.timeout || @timeout
           f.options.timeout = request.timeout || @timeout
+
+          @configure_connection_blocks.each { |block| block.call(f) }
+          f.adapter @adapter
         end
 
         @last_request = request
         @last_response = nil
 
         response = send(request)
-        if response.body && !response.body.empty?
+        if response.status == 504
+          object = { message: 'Request timeout', code: 504 }.to_json
+        elsif response.body && !response.body.empty?
           object = response.body
         elsif response.status == 400
           object = { message: 'Bad request', code: 400 }.to_json

data/lib/twilio-ruby/http.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'http/**/*.rb')].sort.each do |file|
+  require file
+end

data/lib/twilio-ruby/jwt/access_token.rb

@@ -267,6 +267,19 @@ module Twilio
           payload
         end
       end
+
+      class PlaybackGrant
+        include AccessTokenGrant
+        attr_accessor :grant
+
+        def _key
+          'player'
+        end
+
+        def _generate_payload
+          grant
+        end
+      end
     end
   end
 end

data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb

@@ -288,7 +288,7 @@ module Twilio
             end
 
             ##
-            # @return [authorized_connect_app.Permission] Permissions authorized to the app
+            # @return [Array[authorized_connect_app.Permission]] Permissions authorized to the app
             def permissions
               @properties['permissions']
             end

data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb

@@ -19,8 +19,8 @@ module Twilio
               # @param [String] account_sid The SID of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [EventList] EventList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -159,8 +159,8 @@ module Twilio
               # @param [String] account_sid The SID of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [EventInstance] EventInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb

@@ -19,8 +19,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -87,13 +87,27 @@ module Twilio
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Feedback.json"
               end
 
+              ##
+              # Fetch the FeedbackInstance
+              # @return [FeedbackInstance] Fetched FeedbackInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
               ##
               # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Created FeedbackInstance
@@ -113,31 +127,17 @@ module Twilio
                 )
               end
 
-              ##
-              # Fetch the FeedbackInstance
-              # @return [FeedbackInstance] Fetched FeedbackInstance
-              def fetch
-                payload = @version.fetch('GET', @uri)
-
-                FeedbackInstance.new(
-                    @version,
-                    payload,
-                    account_sid: @solution[:account_sid],
-                    call_sid: @solution[:call_sid],
-                )
-              end
-
               ##
               # Update the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
-              def update(quality_score: nil, issue: :unset)
+              def update(quality_score: :unset, issue: :unset)
                 data = Twilio::Values.of({
                     'QualityScore' => quality_score,
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
@@ -176,8 +176,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)
@@ -227,7 +227,7 @@ module Twilio
               end
 
               ##
-              # @return [feedback.Issues] Issues experienced during the call
+              # @return [Array[feedback.Issues]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -244,13 +244,20 @@ module Twilio
                 @properties['sid']
               end
 
+              ##
+              # Fetch the FeedbackInstance
+              # @return [FeedbackInstance] Fetched FeedbackInstance
+              def fetch
+                context.fetch
+              end
+
               ##
               # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Created FeedbackInstance
@@ -258,24 +265,17 @@ module Twilio
                 context.create(quality_score: quality_score, issue: issue, )
               end
 
-              ##
-              # Fetch the FeedbackInstance
-              # @return [FeedbackInstance] Fetched FeedbackInstance
-              def fetch
-                context.fetch
-              end
-
               ##
               # Update the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
-              def update(quality_score: nil, issue: :unset)
+              def update(quality_score: :unset, issue: :unset)
                 context.update(quality_score: quality_score, issue: issue, )
               end
 

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb

@@ -167,14 +167,14 @@ module Twilio
                     'call_feedback_count' => payload['call_feedback_count'].to_i,
                     'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                     'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                    'end_date' => Twilio.deserialize_iso8601_datetime(payload['end_date']),
+                    'end_date' => Twilio.deserialize_iso8601_date(payload['end_date']),
                     'include_subaccounts' => payload['include_subaccounts'],
                     'issues' => payload['issues'],
                     'quality_score_average' => payload['quality_score_average'].to_f,
                     'quality_score_median' => payload['quality_score_median'].to_f,
                     'quality_score_standard_deviation' => payload['quality_score_standard_deviation'].to_f,
                     'sid' => payload['sid'],
-                    'start_date' => Twilio.deserialize_iso8601_datetime(payload['start_date']),
+                    'start_date' => Twilio.deserialize_iso8601_date(payload['start_date']),
                     'status' => payload['status'],
                 }
 
@@ -225,7 +225,7 @@ module Twilio
               end
 
               ##
-              # @return [Time] The latest feedback entry date in the summary
+              # @return [Date] The latest feedback entry date in the summary
               def end_date
                 @properties['end_date']
               end
@@ -237,7 +237,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Issues experienced during the call
+              # @return [Array[Hash]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -267,7 +267,7 @@ module Twilio
               end
 
               ##
-              # @return [Time] The earliest feedback entry date in the summary
+              # @return [Date] The earliest feedback entry date in the summary
               def start_date
                 @properties['start_date']
               end

data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

@@ -33,10 +33,10 @@ module Twilio
 
               ##
               # Create the RecordingInstance
-              # @param [String] recording_status_callback_event The recording status events on
-              #   which we should call the `recording_status_callback` URL. Can be: `in-progress`,
-              #   `completed` and `absent` and the default is `completed`. Separate multiple event
-              #   values with a space.
+              # @param [Array[String]] recording_status_callback_event The recording status
+              #   events on which we should call the `recording_status_callback` URL. Can be:
+              #   `in-progress`, `completed` and `absent` and the default is `completed`. Separate
+              #   multiple event values with a space.
               # @param [String] recording_status_callback The URL we should call using the
               #   `recording_status_callback_method` on each recording event specified in
               #   `recording_status_callback_event`. For more information, see
@@ -53,10 +53,10 @@ module Twilio
               #   Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties
               #   of the call into one channel. `dual` records each party of a 2-party call into
               #   separate channels.
-              # @param [String] recording_track The tracks to record. Can be: `inbound`,
-              #   `outbound`, or `both`. The default is `both`. `inbound` only records the audio
-              #   received by Twilio, `outbound` only records audio generated by Twilio, and
-              #   `both` mixes the inbound and outbound audio.
+              # @param [String] recording_track The audio track to record for the call. Can be:
+              #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
+              #   audio that is received by Twilio. `outbound` records the audio that is generated
+              #   from Twilio. `both` records the audio that is received and generated by Twilio.
               # @return [RecordingInstance] Created RecordingInstance
               def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, recording_track: :unset)
                 data = Twilio::Values.of({