twilio-ruby 5.54.0 → 5.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5566a64b2b4292461e668ceb197a806cee70f04974c5268affc88c2d17b1998
-  data.tar.gz: 170fe096ae57154ce21fdfd0da343ed5081eb490dcb83e6fbd75bd1316832547
+  metadata.gz: 32e36d2240839f716f54c9d7071521c1cfc50f6325477e7fe093b220cc373789
+  data.tar.gz: 3b9e9209db5ddd89b78b1f504e5609d66c5a85aa83f20f55cb133a5d9e54e852
 SHA512:
-  metadata.gz: c19fbdd472d009b389ab1d74a1d4acb44d40b7f8acbf3ccff8b24ebbb4741fe28775cc93df19a663a8d0c59efbd787237e0e1e7cf02fa06b98ff4341e7e0f195
-  data.tar.gz: 2886af917c2518e48f1845322b228cc8947f888aa60fc299c9010990361200eb9eaa0b5a52cc9331b3a56da8903289c91ca4f4d7fa1e3ed1e98f813be2873d52
+  metadata.gz: 98cf8aaa6597b9948f8bc5e1f2d4093284ee71344bd5a104553324a851a50255b97b57b5333e3aeb7dcfbbee5f74d5d8185b943d052a482f7eab431e1bbf084c
+  data.tar.gz: 6ae58a103714ee0150afd19e134488b41f5f0f8ef96d7a0a01c851da749a548654e2c61e0c847227a7d76cf3c7ab5042a4591dcb9eeeaa7d075063307cffbec6

data/CHANGES.md

@@ -1,6 +1,16 @@
 twilio-ruby changelog
 =====================
 
+[2021-06-02] Version 5.54.1
+---------------------------
+**Events**
+- join Sinks and Subscriptions service
+
+**Verify**
+- Improved the documentation of `challenge` adding the maximum and minimum expected lengths of some fields.
+- Improve documentation regarding `notification` by updating the documentation of the field `ttl`.
+
+
 [2021-05-19] Version 5.54.0
 ---------------------------
 **Events**

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

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

@@ -38,16 +38,21 @@ module Twilio
               #   is five (5) minutes after Challenge creation. The max value is sixty (60)
               #   minutes after creation.
               # @param [String] details_message Shown to the user when the push notification
-              #   arrives. Required when `factor_type` is `push`
+              #   arrives. Required when `factor_type` is `push`. Can be up to 256 characters in
+              #   length
               # @param [Array[Hash]] details_fields A list of objects that describe the Fields
               #   included in the Challenge. Each object contains the label and value of the
-              #   field. Used when `factor_type` is `push`.
+              #   field, the label can be up to 36 characters in length and the value can be up to
+              #   128 characters in length. Used when `factor_type` is `push`. There can be up to
+              #   20 details fields.
               # @param [Hash] hidden_details Details provided to give context about the
               #   Challenge. Not shown to the end user. It must be a stringified JSON with only
-              #   strings values eg. `{"ip": "172.168.1.234"}`
+              #   strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in
+              #   length
               # @param [String] auth_payload Optional payload used to verify the Challenge upon
               #   creation. Only used with a Factor of type `totp` to carry the TOTP code that
-              #   needs to be verified.
+              #   needs to be verified. For `TOTP` this value must be between 3 and 8 characters
+              #   long.
               # @return [ChallengeInstance] Created ChallengeInstance
               def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
                 data = Twilio::Values.of({
@@ -246,7 +251,9 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
+              #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
+              #   characters in length
               # @return [ChallengeInstance] Updated ChallengeInstance
               def update(auth_payload: :unset)
                 data = Twilio::Values.of({'AuthPayload' => auth_payload, })
@@ -464,7 +471,9 @@ module Twilio
               ##
               # Update the ChallengeInstance
               # @param [String] auth_payload The optional payload needed to verify the
-              #   Challenge. E.g., a TOTP would use the numeric code.
+              #   Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
+              #   be between 3 and 8 characters long. For `Push` this value can be up to 5456
+              #   characters in length
               # @return [ChallengeInstance] Updated ChallengeInstance
               def update(auth_payload: :unset)
                 context.update(auth_payload: auth_payload, )

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

@@ -34,11 +34,10 @@ module Twilio
 
                 ##
                 # Create the NotificationInstance
-                # @param [String] ttl How long, in seconds, the Notification is valid. Delivery
-                #   will be attempted if the device is offline until the TTL elapses. 0 means that
-                #   the notification delivery is attempted immediately, only once, and is not stored
-                #   for future delivery. Must be an integer between 0 and 300 seconds, inclusive.
-                #   Defaults to 300 seconds.
+                # @param [String] ttl How long, in seconds, the notification is valid. Can be an
+                #   integer between 0 and 300. Default is 300. Delivery is attempted until the TTL
+                #   elapses, even if the device is offline. 0 means that the notification delivery
+                #   is attempted immediately, only once, and is not stored for future delivery.
                 # @return [NotificationInstance] Created NotificationInstance
                 def create(ttl: :unset)
                   data = Twilio::Values.of({'Ttl' => ttl, })
@@ -164,13 +163,13 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The priority of the Notification.
+                # @return [String] The priority of the notification.
                 def priority
                   @properties['priority']
                 end
 
                 ##
-                # @return [String] How long, in seconds, the Notification is valid.
+                # @return [String] How long, in seconds, the notification is valid.
                 def ttl
                   @properties['ttl']
                 end

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '5.54.0'
+    VERSION = '5.54.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 5.54.0
+  version: 5.54.1
 platform: ruby
 authors:
 - Twilio API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt