twilio-ruby 5.61.0 → 5.61.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f67e55070e1d0eddd733aab27eb25aaac27b3ca
-  data.tar.gz: 8152831ec638b70b0bae3a6596080c1fa6c7ced9
+  metadata.gz: f2583fb03b7f76ca77faa5e168a640ee6666859f
+  data.tar.gz: 861886a68fcff99ea6447453fe9293d078d2b0ee
 SHA512:
-  metadata.gz: 4386a3cee85ffba9015d8eb0aba9012fbe5e8465635f96bfe563fafbd2aa6d99c0b4228a6b8dfca7fb958c16175b079eaa44e9c06d1944fdc8fdd630de3f58af
-  data.tar.gz: f57664647dd26b987cd3cc45b6ff2035880bb324acc1b790a9271d66bdbdc7ca12d73164be50fe023e11ece500db1044717db855006791569b903f7d42cdf927
+  metadata.gz: 86c26374082ab77796489dbc76fb3d4098dfec72c9ab0f8ea5c69896ffca74edd38baf6b128489f61f9b14189c93dab29850ac70aa9cae784f1f1e87baff6731
+  data.tar.gz: 390ba0f3829c07b954a5097995a61dec268c05736cf21b1a971527a36436980ca6ecf17abd5371079cb05fac72f23bbb8426560a1dd7ec82ed92287fcc854cb5

data/.github/workflows/deploy.yml

@@ -12,6 +12,8 @@ jobs:
     steps:
       - name: Checkout twilio-ruby
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Login to Docker Hub
         uses: docker/login-action@v1

data/.gitignore

@@ -13,5 +13,6 @@ docs/_build
 *.iml
 .bundle
 .rakeTasks
+.yardoc
 
 coverage

data/CHANGES.md

@@ -1,6 +1,29 @@
 twilio-ruby changelog
 =====================
 
+[2021-11-17] Version 5.61.1
+---------------------------
+**Library - Chore**
+- [PR #578](https://github.com/twilio/twilio-ruby/pull/578): remove yardoc files. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Library - Fix**
+- [PR #576](https://github.com/twilio/twilio-ruby/pull/576): git log retrieval issues. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Frontline**
+- Added `is_available` to User's resource
+
+**Messaging**
+- Added GET vetting API
+
+**Verify**
+- Add `WHATSAPP` to the attempts API.
+- Allow to update `config.notification_platform` from `none` to `apn` or `fcm` and viceversa for Verify Push
+- Add `none` as a valid `config.notification_platform` value for Verify Push
+
+**Twiml**
+- Add supported SSML children to `<emphasis>`, `<lang>`, `<p>`, `<prosody>`, `<s>`, and `<w>`.
+
+
 [2021-11-03] Version 5.61.0
 ---------------------------
 **Library - Chore**

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

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

@@ -144,9 +144,9 @@ module Twilio
             #   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.
+            #   Pass an incoming call's call_token value to a forwarded call via the call_token
+            #   parameter when creating a new call. A forwarded call should bear the same
+            #   CallerID of the original 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

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -94,10 +94,19 @@ module Twilio
           # @param [String] avatar The avatar URL which will be shown in Frontline
           #   application.
           # @param [user.StateType] state Current state of this user. Can be either `active`
-          #   or `deactivated` and defaults to `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
           # @return [UserInstance] Updated UserInstance
-          def update(friendly_name: :unset, avatar: :unset, state: :unset)
-            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Avatar' => avatar, 'State' => state, })
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Avatar' => avatar,
+                'State' => state,
+                'IsAvailable' => is_available,
+            })
 
             payload = @version.update('POST', @uri, data: data)
 
@@ -139,6 +148,7 @@ module Twilio
                 'friendly_name' => payload['friendly_name'],
                 'avatar' => payload['avatar'],
                 'state' => payload['state'],
+                'is_available' => payload['is_available'],
                 'url' => payload['url'],
             }
 
@@ -188,6 +198,12 @@ module Twilio
             @properties['state']
           end
 
+          ##
+          # @return [Boolean] Whether the User is available for new conversations
+          def is_available
+            @properties['is_available']
+          end
+
           ##
           # @return [String] An absolute URL for this user.
           def url
@@ -207,10 +223,19 @@ module Twilio
           # @param [String] avatar The avatar URL which will be shown in Frontline
           #   application.
           # @param [user.StateType] state Current state of this user. Can be either `active`
-          #   or `deactivated` and defaults to `active`
+          #   or `deactivated`.
+          # @param [Boolean] is_available Whether the User is available for new
+          #   conversations. Set to `false` to prevent User from receiving new inbound
+          #   conversations if you are using {Pool
+          #   Routing}[https://www.twilio.com/docs/frontline/handle-incoming-conversations#3-pool-routing].
           # @return [UserInstance] Updated UserInstance
-          def update(friendly_name: :unset, avatar: :unset, state: :unset)
-            context.update(friendly_name: friendly_name, avatar: avatar, state: state, )
+          def update(friendly_name: :unset, avatar: :unset, state: :unset, is_available: :unset)
+            context.update(
+                friendly_name: friendly_name,
+                avatar: avatar,
+                state: state,
+                is_available: is_available,
+            )
           end
 
           ##

data/lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb

@@ -166,6 +166,54 @@ module Twilio
             end
           end
 
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class BrandVettingContext < InstanceContext
+            ##
+            # Initialize the BrandVettingContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] brand_sid The SID of the Brand Registration resource of the
+            #   vettings to read .
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
+            # @return [BrandVettingContext] BrandVettingContext
+            def initialize(version, brand_sid, brand_vetting_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {brand_sid: brand_sid, brand_vetting_sid: brand_vetting_sid, }
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings/#{@solution[:brand_vetting_sid]}"
+            end
+
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              BrandVettingInstance.new(
+                  @version,
+                  payload,
+                  brand_sid: @solution[:brand_sid],
+                  brand_vetting_sid: @solution[:brand_vetting_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
+            end
+          end
+
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class BrandVettingInstance < InstanceResource
@@ -174,8 +222,10 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] brand_sid The unique string to identify Brand Registration.
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
             # @return [BrandVettingInstance] BrandVettingInstance
-            def initialize(version, payload, brand_sid: nil)
+            def initialize(version, payload, brand_sid: nil, brand_vetting_sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -191,6 +241,28 @@ module Twilio
                   'vetting_provider' => payload['vetting_provider'],
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'brand_sid' => brand_sid,
+                  'brand_vetting_sid' => brand_vetting_sid || @properties['brand_vetting_sid'],
+              }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [BrandVettingContext] BrandVettingContext for this BrandVettingInstance
+            def context
+              unless @instance_context
+                @instance_context = BrandVettingContext.new(
+                    @version,
+                    @params['brand_sid'],
+                    @params['brand_vetting_sid'],
+                )
+              end
+              @instance_context
             end
 
             ##
@@ -253,16 +325,25 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              context.fetch
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Messaging.V1.BrandVettingInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Messaging.V1.BrandVettingInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
           end
         end

data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

@@ -201,8 +201,14 @@ module Twilio
           ##
           # Access the brand_vettings
           # @return [BrandVettingList]
-          # @return [BrandVettingContext]
-          def brand_vettings
+          # @return [BrandVettingContext] if brand_vetting_sid was passed.
+          def brand_vettings(brand_vetting_sid=:unset)
+            raise ArgumentError, 'brand_vetting_sid cannot be nil' if brand_vetting_sid.nil?
+
+            if brand_vetting_sid != :unset
+              return BrandVettingContext.new(@version, @solution[:sid], brand_vetting_sid, )
+            end
+
             unless @brand_vettings
               @brand_vettings = BrandVettingList.new(@version, brand_sid: @solution[:sid], )
             end

data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

@@ -219,8 +219,12 @@ module Twilio
               #   Must be between 3 and 8, inclusive
               # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
               #   codes. Can be `sha1`, `sha256` or `sha512`
+              # @param [String] config_notification_platform The transport technology used to
+              #   generate the Notification Token. Can be `apn`, `fcm` or `none`.
+              #
+              #   Required when `factor_type` is `push`.
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset)
                 data = Twilio::Values.of({
                     'AuthPayload' => auth_payload,
                     'FriendlyName' => friendly_name,
@@ -230,6 +234,7 @@ module Twilio
                     'Config.Skew' => config_skew,
                     'Config.CodeLength' => config_code_length,
                     'Config.Alg' => config_alg,
+                    'Config.NotificationPlatform' => config_notification_platform,
                 })
 
                 payload = @version.update('POST', @uri, data: data)
@@ -419,8 +424,12 @@ module Twilio
               #   Must be between 3 and 8, inclusive
               # @param [factor.TotpAlgorithms] config_alg The algorithm used to derive the TOTP
               #   codes. Can be `sha1`, `sha256` or `sha512`
+              # @param [String] config_notification_platform The transport technology used to
+              #   generate the Notification Token. Can be `apn`, `fcm` or `none`.
+              #
+              #   Required when `factor_type` is `push`.
               # @return [FactorInstance] Updated FactorInstance
-              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset)
+              def update(auth_payload: :unset, friendly_name: :unset, config_notification_token: :unset, config_sdk_version: :unset, config_time_step: :unset, config_skew: :unset, config_code_length: :unset, config_alg: :unset, config_notification_platform: :unset)
                 context.update(
                     auth_payload: auth_payload,
                     friendly_name: friendly_name,
@@ -430,6 +439,7 @@ module Twilio
                     config_skew: config_skew,
                     config_code_length: config_code_length,
                     config_alg: config_alg,
+                    config_notification_platform: config_notification_platform,
                 )
               end
 

data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb

@@ -56,8 +56,8 @@ module Twilio
               #
               #   Required when `factor_type` is `push`.
               # @param [new_factor.NotificationPlatforms] config_notification_platform The
-              #   transport technology used to generate the Notification Token. Can be `apn` or
-              #   `fcm`.
+              #   transport technology used to generate the Notification Token. Can be `apn`,
+              #   `fcm` or `none`.
               #
               #   Required when `factor_type` is `push`.
               # @param [String] config_notification_token For APN, the device token. For FCM,