twilio-ruby 5.47.0 → 5.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6700c468ebeba0a532743b8fda07b0611eba016340131154d55d96066e7b2dd8
-  data.tar.gz: ffc4dcf43f721f14576d2088c86c224d5b62a46cc78d61858010a0f0e89f1208
+  metadata.gz: d99e1efb1e1e2c8f1ec1d259ad5b04698f53687fb7458c722a9bc6059ebbf0ad
+  data.tar.gz: 55d03d89201d62c477176cf9a7cc3febfe86af7a10f23803e447b78086ec7c20
 SHA512:
-  metadata.gz: 2ded7f1d5f29833cda6ccd65c7d732a4c21f747cee61564898ec73ca3bce24d866046010ca7665f504537dcaf59e4c1b56f18719bc0ead92ed6185ef6646d6ad
-  data.tar.gz: 9636e0a2664beb12524698215bdb20104d6415d0be295cb363886ead20e43febd4797edd9b159239ee58607a3ac0adaf5fa3f10129a6d18382d0a4c8e6a48240
+  metadata.gz: 9bf624df014df8c56d9c8bb31d39d436f858ac008d05a501392cf801401f0e6784418c65153117184f4d0c50f494647dd0ba04f1e16d8c99597acfda9c0a69ab
+  data.tar.gz: cda0c92b279012c44b60921e177619c7af1570a2bb6c7afcee165b3c988d7530e18972c8f281c4c71e9f8dc4f58db687dbb0dfd56a1da4d84966e742e2da3cc0

data/CHANGES.md

@@ -1,6 +1,131 @@
 twilio-ruby changelog
 =====================
 
+[2021-04-21] Version 5.52.0
+---------------------------
+**Api**
+- Revert Update the conference participant create `from` and `to` param to be endpoint type for supporting client identifier and sip address
+- Update the conference participant create `from` and `to` param to be endpoint type for supporting client identifier and sip address
+
+**Bulkexports**
+- moving enum to doc root for auto generating documentation
+- adding status enum and default output properties
+
+**Events**
+- Change schema_versions prop and key to versions **(breaking change)**
+
+**Messaging**
+- Add `use_inbound_webhook_on_number` field in Service API for fetch, create, update, read
+
+**Taskrouter**
+- Add `If-Match` Header based on ETag for Task Delete
+
+**Verify**
+- Add `AuthPayload` parameter to support verifying a `Challenge` upon creation. This is only supported for `totp` factors.
+- Add support to resend the notifications of a `Challenge`. This is only supported for `push` factors.
+
+**Twiml**
+- Add Polly Neural voices.
+
+
+[2021-04-07] Version 5.51.0
+---------------------------
+**Library - Chore**
+- [PR #551](https://github.com/twilio/twilio-ruby/pull/551): omit spec/ from .gem file. Thanks to [@mroach](https://github.com/mroach)!
+
+**Api**
+- Added `announcement` event to conference status callback events
+- Removed optional property `time_limit` in the call create request. **(breaking change)**
+
+**Messaging**
+- Add rate_limits field to Messaging Services US App To Person API
+- Add usecase field in Service API for fetch, create, update, read
+- Add us app to person api and us app to person usecase api as dependents in service
+- Add us_app_to_person_registered field in service api for fetch, read, create, update
+- Add us app to person api
+- Add us app to person usecase api
+- Add A2P external campaign api
+- Add Usecases API
+
+**Supersim**
+- Add Create endpoint to Sims resource
+
+**Verify**
+- The `Binding` field is now returned when creating a `Factor`. This value won't be returned for other endpoints.
+
+**Video**
+- [Rooms] max_concurrent_published_tracks has got GA maturity
+
+**Twiml**
+- Add `announcement` event to `statusCallbackEvent` for `<Conference>`.
+
+
+[2021-03-24] Version 5.50.0
+---------------------------
+**Api**
+- Added optional parameter `CallToken` for create calls api
+- Add optional property `time_limit` in the call create request.
+
+**Bulkexports**
+- adding two new fields with job api queue_position and estimated_completion_time
+
+**Events**
+- Add new endpoints to manage subscribed_events in subscriptions
+
+**Numbers**
+- Remove feature flags for RegulatoryCompliance endpoints
+
+**Supersim**
+- Add SmsCommands resource
+- Add fields `SmsCommandsUrl`, `SmsCommandsMethod` and `SmsCommandsEnabled` to a Fleet resource
+
+**Taskrouter**
+- Add `If-Match` Header based on ETag for Task Update
+- Add `ETag` as Response Headers to Tasks and Reservations
+
+**Video**
+- Recording rule beta flag **(breaking change)**
+- [Rooms] Add RecordingRules param to Rooms
+
+
+[2021-03-15] Version 5.49.0
+---------------------------
+**Library - Fix**
+- [PR #550](https://github.com/twilio/twilio-ruby/pull/550): regenerating with the path parameter fix. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Events**
+- Set maturity to beta
+
+**Messaging**
+- Adjust A2P brand registration status enum **(breaking change)**
+
+**Studio**
+- Remove internal safeguards for Studio V2 API usage now that it's GA
+
+**Verify**
+- Add support for creating and verifying totp factors. Support for totp factors is behind the `api.verify.totp` beta feature.
+
+**Twiml**
+- Add support for `<VirtualAgent>` noun
+
+
+[2021-02-24] Version 5.48.0
+---------------------------
+**Events**
+- Update description of types in the create sink resource
+
+**Messaging**
+- Add WA template header and footer
+- Remove A2P campaign and use cases API **(breaking change)**
+- Add number_registration_status field to read and fetch campaign responses
+
+**Trusthub**
+- Make all resources public
+
+**Verify**
+- Verify List Attempts API endpoints added.
+
+
 [2021-02-10] Version 5.47.0
 ---------------------------
 **Library - Fix**

data/README.md

@@ -1,6 +1,6 @@
 # twilio-ruby
 
-[![Build Status](https://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Build Status](https://img.shields.io/travis/com/twilio/twilio-ruby.svg)][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.47.0'
+gem 'twilio-ruby', '~> 5.52.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.47.0
+gem install twilio-ruby -v 5.52.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -95,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'
@@ -111,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
@@ -248,7 +249,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/lib/twilio-ruby/rest/api.rb

@@ -86,7 +86,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that that we created to identify this Call
+      # @param [String] sid The unique string that we created to identify this Call
       #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallList]

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

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Api::V2010::AccountList]
         def accounts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @accounts ||= AccountList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @accounts ||= AccountList.new self
           else
-            AccountContext.new(self, sid)
+              AccountContext.new(self, sid)
           end
         end
 

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

@@ -142,6 +142,11 @@ module Twilio
             # @param [String] call_reason The Reason for the outgoing call. Use it to specify
             #   the purpose of the call that is presented on the called party's phone. (Branded
             #   Calls Beta)
+            # @param [String] call_token A token string needed to invoke a forwarded call. A
+            #   call_token is generated when an incoming call is received on a Twilio number.
+            #   this field should be populated by the incoming call's call_token to make this
+            #   outgoing call as a forwarded call of incoming call. A forwarded call should bear
+            #   the same caller-id of incoming call.
             # @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
@@ -157,7 +162,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, 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, url: :unset, twiml: :unset, application_sid: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -191,6 +196,7 @@ module Twilio
                   'AsyncAmdStatusCallbackMethod' => async_amd_status_callback_method,
                   'Byoc' => byoc,
                   'CallReason' => call_reason,
+                  'CallToken' => call_token,
                   'RecordingTrack' => recording_track,
               })
 

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)
@@ -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)

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`, and `speaker`. Separate
-              #   multiple values with a space. Defaults to `start end`.
+              #   `start`, `end`, `join`, `leave`, `mute`, `hold`, `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

data/lib/twilio-ruby/rest/autopilot/v1.rb

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Autopilot::V1::AssistantList]
         def assistants(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @assistants ||= AssistantList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @assistants ||= AssistantList.new self
           else
-            AssistantContext.new(self, sid)
+              AssistantContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/bulkexports/v1.rb

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Bulkexports::V1::ExportList]
         def exports(resource_type=:unset)
           if resource_type.nil?
-            raise ArgumentError, 'resource_type cannot be nil'
-          elsif resource_type == :unset
-            @exports ||= ExportList.new self
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @exports ||= ExportList.new self
           else
-            ExportContext.new(self, resource_type)
+              ExportContext.new(self, resource_type)
           end
         end
 
@@ -41,11 +42,12 @@ module Twilio
         # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
         def export_configuration(resource_type=:unset)
           if resource_type.nil?
-            raise ArgumentError, 'resource_type cannot be nil'
-          elsif resource_type == :unset
-            @export_configuration ||= ExportConfigurationList.new self
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @export_configuration ||= ExportConfigurationList.new self
           else
-            ExportConfigurationContext.new(self, resource_type)
+              ExportConfigurationContext.new(self, resource_type)
           end
         end
 

data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

@@ -202,6 +202,8 @@ module Twilio
                   'email' => payload['email'],
                   'job_sid' => payload['job_sid'],
                   'details' => payload['details'],
+                  'job_queue_position' => payload['job_queue_position'],
+                  'estimated_completion_time' => payload['estimated_completion_time'],
               }
             end
 
@@ -254,11 +256,23 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job
+            # @return [Hash] The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job
             def details
               @properties['details']
             end
 
+            ##
+            # @return [String] This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
+            def job_queue_position
+              @properties['job_queue_position']
+            end
+
+            ##
+            # @return [String] this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
+            def estimated_completion_time
+              @properties['estimated_completion_time']
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb

@@ -136,6 +136,8 @@ module Twilio
                   'webhook_method' => payload['webhook_method'],
                   'email' => payload['email'],
                   'url' => payload['url'],
+                  'job_queue_position' => payload['job_queue_position'],
+                  'estimated_completion_time' => payload['estimated_completion_time'],
               }
 
               # Context
@@ -167,7 +169,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status
+            # @return [Hash] The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job
             def details
               @properties['details']
             end
@@ -214,6 +216,18 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
+            def job_queue_position
+              @properties['job_queue_position']
+            end
+
+            ##
+            # @return [String] this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
+            def estimated_completion_time
+              @properties['estimated_completion_time']
+            end
+
             ##
             # Fetch the JobInstance
             # @return [JobInstance] Fetched JobInstance

data/lib/twilio-ruby/rest/chat/v1.rb

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -41,11 +42,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end