twilio-ruby 5.55.0 → 5.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c72bbd9cbefca5721d0511533669f45267080d0d5fa0737782fd92fc70d6751
-  data.tar.gz: 8b3365ed643f116a3ee5f1ca74d6e0e52e5c02cd0d51213a899fac3045f92773
+  metadata.gz: 90245670a85b148807ee4a2be28da950b65530413eef56cf403e16708222a5d4
+  data.tar.gz: e279a65d127e4b629c904a9de0081c03effd7fa76ec73aa945bb52a8f4d32806
 SHA512:
-  metadata.gz: 8c3731c318a3e0638f05f4670c59e5f4f6bd395c8ca317d5f60ef80d541cd6938c24b925d984255a648575736f087578731d0495590c526eb260aaa0c6b3f74c
-  data.tar.gz: aa0b3121b2df4f92be392302dbf60272ec3fce6e3b1e346f5c6d51c1bc1263706368a75d162d434f1058646ee0e43e4e73e6f76ab735bf55c1a9549f48332308
+  metadata.gz: f4cf12efd6b9c6b1a8dd4d3239c369e1592cb920e1c2c68451e5e835dcb43a1aa2d914b2fc6eaadd4daa65c09c980278d2fa6fd09723db8ecede21023bc38108
+  data.tar.gz: f92a04a5901154ccdb52b8a79dce167019b61177e90cc050774a2f1bfcb6a3b466b73fe92639363bdc43a697845423fd9d4d00e9ff1cad9fe34c9ae27329c831

data/.gitignore

@@ -12,3 +12,5 @@ bin
 docs/_build
 *.bak
 *.iml
+
+coverage

data/.rubocop_todo.yml

@@ -66,7 +66,7 @@ Lint/UnusedBlockArgument:
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/twilio-ruby.rb'
-    - 'lib/twilio-ruby/framework/page.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
     - 'spec/holodeck/holodeck.rb'
 
 # Offense count: 1
@@ -130,7 +130,7 @@ Style/FrozenStringLiteralComment:
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/twilio-ruby/framework/page.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -144,8 +144,8 @@ Style/HashSyntax:
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
-    - 'lib/twilio-ruby/framework/page.rb'
-    - 'lib/twilio-ruby/framework/version.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
+    - 'lib/twilio-ruby/framework/rest/version.rb'
     - 'lib/twilio-ruby/jwt/access_token.rb'
     - 'lib/twilio-ruby/jwt/client_capability.rb'
     - 'lib/twilio-ruby/jwt/jwt.rb'
@@ -168,9 +168,9 @@ Style/RedundantSelf:
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
-    - 'lib/twilio-ruby/framework/domain.rb'
-    - 'lib/twilio-ruby/framework/helper.rb'
-    - 'lib/twilio-ruby/framework/version.rb'
+    - 'lib/twilio-ruby/framework/rest/domain.rb'
+    - 'lib/twilio-ruby/framework/rest/helper.rb'
+    - 'lib/twilio-ruby/framework/rest/version.rb'
     - 'spec/rack/twilio_webhook_authentication_spec.rb'
 
 # Offense count: 5

data/.travis.yml

@@ -3,17 +3,29 @@ cache: bundler
 bundler_args: "--without development"
 rvm:
 - ruby-head
-- 3.0
-- 2.7
-- 2.6
-- 2.5
-- 2.4
 - jruby-9.2
+- 2.4
+- 2.5
+- 2.6
+- 2.7
+- 3.0
 services:
 - docker
 install: make install
-script: make test
+script:
+- make test
+- if [[ "$TRAVIS_BRANCH" == "main"  ||  "$TRAVIS_BRANCH" == "travis" ]] && [ "$TRAVIS_PULL_REQUEST"
+  == "false" ]; then echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}"
+  --password-stdin; fi
 matrix:
+  include:
+    - language: ruby
+      rvm: '3.0'
+      # The below workaround is necessary because of the branch coverage inclusion in simplecov 0.18+
+      # more discussion here - https://community.sonarsource.com/t/ruby-coverage-simplecov-json-file-does-not-work/20909/7
+      after_success:
+        - ruby -rjson -e 'sqube = JSON.load(File.read("coverage/.resultset.json"))["RSpec"]["coverage"].transform_values {|lines| lines["lines"]}; total = { "RSpec" => { "coverage" => sqube, "timestamp" => Time.now.to_i }}; puts JSON.dump(total)' > coverage/.resultset.sonarqube.json
+        - sonar-scanner
   allow_failures:
   - rvm: ruby-head
   fast_finish: true
@@ -37,3 +49,8 @@ notifications:
     on_failure: change
     rooms:
       secure: HG7rC5VSDOZiLCkpTsC4ZImh1k59OPi6YEjYKhdGXItybLHa6Yh5C42WvSx3kVW3SeyLOm1CiaMv+pbBZUXStXYsl8eH69MbEZimhDWsPs/m+bh+gEISov22WNUs3ZfUqIXMIb6v18oXPp2Qa1gX5LUEAGoSxHWNmCAcHayWl7M=
+addons:
+  sonarcloud:
+    organization: twilio
+    token:
+      secure: OSEahx/yO/r9PdjXbASwJt+ogphxkDDpnlajWNCBTc+hoiEurGP/12CN0oQi7+iishIgIowqo5J9/+m1BQfsAv4fKST+t6mSazx27udiiM9am03lhviW8QSG6STADvtq6uJRqTXMk3WehoSidNRYXamVdCoBbqxCSaMX8MbMsN8=

data/CHANGES.md

@@ -1,6 +1,79 @@
 twilio-ruby changelog
 =====================
 
+[2021-08-11] Version 5.58.0
+---------------------------
+**Library - Chore**
+- [PR #566](https://github.com/twilio/twilio-ruby/pull/566): integrate sonarcloud. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Library - Docs**
+- [PR #565](https://github.com/twilio/twilio-ruby/pull/565): update mms example to use media_url. Thanks to [@cnorm35](https://github.com/cnorm35)!
+
+**Api**
+- Corrected the `price`, `call_sid_to_coach`, and `uri` data types for Conference, Participant, and Recording **(breaking change)**
+- Made documentation for property `time_limit` in the call api public. **(breaking change)**
+- Added `domain_sid` in sip_credential_list_mapping and sip_ip_access_control_list_mapping APIs **(breaking change)**
+
+**Insights**
+- Added new endpoint to fetch Call Summaries
+
+**Messaging**
+- Add brand_type field to a2p brand_registration api
+- Revert brand registration api update to add brand_type field
+- Add brand_type field to a2p brand_registration api
+
+**Taskrouter**
+- Add `X-Rate-Limit-Limit`, `X-Rate-Limit-Remaining`, and `X-Rate-Limit-Config` as Response Headers to all TaskRouter endpoints
+
+**Verify**
+- Add `TemplateSid` optional parameter on Verification creation.
+- Include `whatsapp` as a channel type in the verifications API.
+
+
+[2021-07-28] Version 5.57.1
+---------------------------
+**Conversations**
+- Expose ParticipantConversations resource
+
+**Taskrouter**
+- Adding `links` to the activity resource
+
+**Verify**
+- Added a `Version` to Verify Factors `Webhooks` to add new fields without breaking old Webhooks.
+
+
+[2021-07-14] Version 5.57.0
+---------------------------
+**Conversations**
+- Changed `last_read_message_index` and `unread_messages_count` type in User Conversation's resource **(breaking change)**
+- Expose UserConversations resource
+
+**Messaging**
+- Add brand_score field to brand registration responses
+
+
+[2021-06-30] Version 5.56.0
+---------------------------
+**Library - Feature**
+- [PR #559](https://github.com/twilio/twilio-ruby/pull/559): Add `Twilio::HTTP::Client#configure_connection`. Thanks to [@darwinShopify](https://github.com/darwinShopify)!
+- [PR #558](https://github.com/twilio/twilio-ruby/pull/558): Autoload Twilio::REST and Twilio::HTTP. Thanks to [@gmcgibbon](https://github.com/gmcgibbon)!
+
+**Conversations**
+- Read-only Conversation Email Binding property `binding`
+
+**Supersim**
+- Add Billing Period resource for the Super Sim Pilot
+- Add List endpoint to Billing Period resource for Super Sim Pilot
+- Add Fetch endpoint to Billing Period resource for Super Sim Pilot
+
+**Taskrouter**
+- Update `transcribe` & `transcription_configuration` form params in Reservation update endpoint to have private visibility **(breaking change)**
+- Add `transcribe` & `transcription_configuration` form params to Reservation update endpoint
+
+**Twiml**
+- Add `modify` event to `statusCallbackEvent` for `<Conference>`.
+
+
 [2021-06-16] Version 5.55.0
 ---------------------------
 **Api**

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+gem 'simplecov', require: false, group: :test
 gemspec

data/README.md

@@ -35,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.55.0'
+gem 'twilio-ruby', '~> 5.58.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.55.0
+gem install twilio-ruby -v 5.58.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -158,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

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.rb

@@ -16,27 +16,17 @@ require 'twilio-ruby/util'
 require 'twilio-ruby/security/request_validator'
 require 'twilio-ruby/util/configuration'
 
-Dir[File.dirname(__FILE__) + '/twilio-ruby/http/**/*.rb'].sort.each do |file|
-  require file
-end
-Dir[File.dirname(__FILE__) + '/twilio-ruby/framework/**/*.rb'].sort.each do |file|
-  require file
-end
-Dir[File.dirname(__FILE__) + '/twilio-ruby/rest/*.rb'].sort.each do |file|
-  require file
-end
-Dir[File.dirname(__FILE__) + '/twilio-ruby/rest/**/*.rb'].sort.each do |file|
-  require file
-end
-Dir[File.dirname(__FILE__) + '/twilio-ruby/compatibility/**/*.rb'].sort.each do |file|
+Dir[File.join(__dir__, 'twilio-ruby/framework/*.rb')].sort.each do |file|
   require file
 end
 
 module Twilio
   extend SingleForwardable
 
-  autoload :JWT, File.join(File.dirname(__FILE__), 'twilio-ruby', 'jwt', 'jwt.rb')
-  autoload :TwiML, File.join(File.dirname(__FILE__), 'twilio-ruby', 'twiml', 'twiml.rb')
+  autoload :JWT, File.join(__dir__, 'twilio-ruby', 'jwt', 'jwt.rb')
+  autoload :TwiML, File.join(__dir__, 'twilio-ruby', 'twiml', 'twiml.rb')
+  autoload :HTTP, File.join(__dir__, 'twilio-ruby', 'http.rb')
+  autoload :REST, File.join(__dir__, 'twilio-ruby', 'rest.rb')
 
   def_delegators :configuration, :account_sid, :auth_token, :http_client, :region, :edge, :logger
 

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/http/http_client.rb

@@ -16,18 +16,28 @@ 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.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

data/lib/twilio-ruby/rest.rb

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

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

@@ -151,6 +151,8 @@ module Twilio
             #   `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.
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @param [String] url The absolute URL that returns the TwiML instructions for the
             #   call. We will call this URL using the `method` when the call connects. For more
             #   information, see the {Url
@@ -162,7 +164,7 @@ module Twilio
             # @param [String] application_sid The SID of the Application resource that will
             #   handle the call, if the call will be handled by an application.
             # @return [CallInstance] Created CallInstance
-            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, call_token: :unset, recording_track: :unset, url: :unset, twiml: :unset, application_sid: :unset)
+            def create(to: nil, from: nil, method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, send_digits: :unset, timeout: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, machine_detection: :unset, machine_detection_timeout: :unset, recording_status_callback_event: :unset, trim: :unset, caller_id: :unset, machine_detection_speech_threshold: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_silence_timeout: :unset, async_amd: :unset, async_amd_status_callback: :unset, async_amd_status_callback_method: :unset, byoc: :unset, call_reason: :unset, call_token: :unset, recording_track: :unset, time_limit: :unset, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -198,6 +200,7 @@ module Twilio
                   'CallReason' => call_reason,
                   'CallToken' => call_token,
                   'RecordingTrack' => recording_track,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -488,8 +491,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               data = Twilio::Values.of({
                   'Url' => url,
                   'Method' => method,
@@ -499,6 +504,7 @@ module Twilio
                   'StatusCallback' => status_callback,
                   'StatusCallbackMethod' => status_callback_method,
                   'Twiml' => twiml,
+                  'TimeLimit' => time_limit,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -874,8 +880,10 @@ module Twilio
             #   `POST`. If an `application_sid` parameter is present, this parameter is ignored.
             # @param [String] twiml TwiML instructions for the call Twilio will use without
             #   fetching Twiml from url. Twiml and url parameters are mutually exclusive
+            # @param [String] time_limit The maximum duration of the call in seconds.
+            #   Constraints depend on account and configuration.
             # @return [CallInstance] Updated CallInstance
-            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset)
+            def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :unset)
               context.update(
                   url: url,
                   method: method,
@@ -885,6 +893,7 @@ module Twilio
                   status_callback: status_callback,
                   status_callback_method: status_callback_method,
                   twiml: twiml,
+                  time_limit: time_limit,
               )
             end
 

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

@@ -107,8 +107,8 @@ module Twilio
               #   `POST`.
               # @param [Array[String]] conference_status_callback_event The conference state
               #   changes that should generate a call to `conference_status_callback`. Can be:
-              #   `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`, and `announcement`.
-              #   Separate multiple values with a space. Defaults to `start end`.
+              #   `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and
+              #   `announcement`. Separate multiple values with a space. Defaults to `start end`.
               # @param [String] recording_channels The recording channels for the final
               #   recording. Can be: `mono` or `dual` and the default is `mono`.
               # @param [String] recording_status_callback The URL that we should call using the
@@ -130,13 +130,14 @@ module Twilio
               #   `POST` and defaults to `POST`.
               # @param [Array[String]] recording_status_callback_event The recording state
               #   changes that should generate a call to `recording_status_callback`. Can be:
-              #   `in-progress`, `completed`, and `failed`. Separate multiple values with a space.
-              #   The default value is `in-progress completed failed`.
+              #   `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`,
+              #   and `absent`. Separate multiple values with a space, ex: `'in-progress completed
+              #   failed'`.
               # @param [Array[String]] conference_recording_status_callback_event The conference
               #   recording state changes that generate a call to
-              #   `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and
-              #   `failed`. Separate multiple values with a space. The default value is
-              #   `in-progress completed failed`.
+              #   `conference_recording_status_callback`. Can be: `in-progress`, `completed`,
+              #   `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress
+              #   completed failed'`
               # @param [Boolean] coaching Whether the participant is coaching another call. Can
               #   be: `true` or `false`. If not present, defaults to `false` unless
               #   `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.
@@ -166,8 +167,10 @@ module Twilio
               #   `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the
               #   audio that is received by Twilio. `outbound` records the audio that is sent from
               #   Twilio. `both` records the audio that is received and sent by Twilio.
+              # @param [String] time_limit The maximum duration of the call in seconds.
+              #   Constraints depend on account and configuration.
               # @return [ParticipantInstance] Created ParticipantInstance
-              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, label: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, jitter_buffer_size: :unset, byoc: :unset, caller_id: :unset, call_reason: :unset, recording_track: :unset)
+              def create(from: nil, to: nil, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, label: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_record: :unset, conference_trim: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, sip_auth_username: :unset, sip_auth_password: :unset, region: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, recording_status_callback_event: :unset, conference_recording_status_callback_event: :unset, coaching: :unset, call_sid_to_coach: :unset, jitter_buffer_size: :unset, byoc: :unset, caller_id: :unset, call_reason: :unset, recording_track: :unset, time_limit: :unset)
                 data = Twilio::Values.of({
                     'From' => from,
                     'To' => to,
@@ -207,6 +210,7 @@ module Twilio
                     'CallerId' => caller_id,
                     'CallReason' => call_reason,
                     'RecordingTrack' => recording_track,
+                    'TimeLimit' => time_limit,
                 })
 
                 payload = @version.create('POST', @uri, data: data)