twilio-ruby 5.20.1 → 5.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38fbbb8fdafaa970b3a19edb564f5663fdce3ff3b5f2acdefd403e3a7beb148a
-  data.tar.gz: 6aabfd32a0b6c211c3fed5945a96d651cbbb9e7baacafd2d3b35a4d8a40203ba
+  metadata.gz: e76b1c0b609320ed1401564614b95de7c3918233d476cf0643b0db1a04e777c7
+  data.tar.gz: 4655a995ac910997607ad48f315885bae18e6414b099a1664016049b97c61115
 SHA512:
-  metadata.gz: dc346aa4a94b6582c69f6b786a88b1e6d4b89c28f42202b14a9b7b3cba9d82162c76ee780b11e1ff5e0ab8e3f99a015c057ca6d6dc128f6abb9e230e1aa29e26
-  data.tar.gz: '05770668bae2703122fe4848df3b1f304348528c3fff9b5977a1afef5122ba3e9203fafa337b7965baf131f6b239d1eb087aece89e2e7ad95483270b7d0c1858'
+  metadata.gz: 60d475fe9b525b2cef55c07d4d0fc8b9fd9f352b9efd7e297fc9bbaf1ec247bcbc7e500a4b2355a8ef0ac4b1b25d939899235e075b9eddf85b055078d0e968ef
+  data.tar.gz: 725b04b2d2832e64e4769c1c63ee0e0f48d42f26d0547eca8c9015bf83a69de67b533fc27c8af2c6b9f7a4b6922c8066ef9af56d5a2c9b8971ce5fa9f6710c54

data/CHANGES.md

@@ -1,6 +1,28 @@
 twilio-ruby changelog
 =====================
 
+[2019-03-01] Version 5.21.0
+----------------------------
+**Api**
+- Make conference participant preview parameters public
+
+**Authy**
+- Added support for FactorType and FactorStrength for Factors and Challenges
+
+**Iam**
+- First public release
+
+**Verify**
+- Add endpoint to update/cancel a Verification **(breaking change)**
+
+**Video**
+- [Composer] Make RoomSid mandatory **(breaking change)**
+- [Composer] Add `enqueued` state to Composition
+
+**Twiml**
+- Update message body to not be required for TwiML `Dial` noun.
+
+
 [2019-02-15] Version 5.20.1
 ----------------------------
 **Library**

data/README.md

@@ -27,13 +27,13 @@ in-line code documentation here in the library.
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.20.1'
+gem 'twilio-ruby', '~> 5.21.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.20.1
+gem install twilio-ruby -v 5.21.0
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/accounts/v1/credential.rb

@@ -28,8 +28,8 @@ module Twilio
 
           ##
           # Access the public_key
-          # @param [String] sid The Credential Sid that uniquely identifies the Credential
-          #   to fetch
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   PublicKey resource to fetch.
           # @return [PublicKeyList]
           # @return [PublicKeyContext] if sid was passed.
           def public_key(sid=:unset)
@@ -44,8 +44,8 @@ module Twilio
 
           ##
           # Access the aws
-          # @param [String] sid The Credential Sid that uniquely identifies the Credential
-          #   to fetch
+          # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+          #   resource to fetch.
           # @return [AwsList]
           # @return [AwsContext] if sid was passed.
           def aws(sid=:unset)

data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

@@ -109,13 +109,14 @@ module Twilio
             ##
             # Retrieve a single page of AwsInstance records from the API.
             # Request is executed immediately.
-            # @param [String] credentials String containing AWS access credentials with format
-            #   <AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>, e.g.
-            #   AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
-            # @param [String] account_sid The Subaccount this Credential should be associated
-            #   with. Needs to be a valid Subaccount of the account issuing the request
+            # @param [String] credentials A string that contains the AWS access credentials in
+            #   the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example,
+            #   `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] account_sid The SID of the Subaccount that this Credential
+            #   should be associated with. Must be a valid Subaccount of the account issuing the
+            #   request.
             # @return [AwsInstance] Newly created AwsInstance
             def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
@@ -173,8 +174,8 @@ module Twilio
             ##
             # Initialize the AwsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+            #   resource to fetch.
             # @return [AwsContext] AwsContext
             def initialize(version, sid)
               super(version)
@@ -201,8 +202,8 @@ module Twilio
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -243,8 +244,8 @@ module Twilio
             # Initialize the AwsInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+            #   resource to fetch.
             # @return [AwsInstance] AwsInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -276,31 +277,31 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] AccountSid the Credential resource belongs to
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] A human readable description of this resource
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -320,8 +321,8 @@ module Twilio
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

@@ -109,12 +109,14 @@ module Twilio
             ##
             # Retrieve a single page of PublicKeyInstance records from the API.
             # Request is executed immediately.
-            # @param [String] public_key URL encoded representation of the public key, e.g.
-            #   -----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
-            # @param [String] account_sid The Subaccount this Credential should be associated
-            #   with. Needs to be a valid Subaccount of the account issuing the request
+            # @param [String] public_key A URL encoded representation of the public key. For
+            #   example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC
+            #   KEY-----`
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] account_sid The SID of the Subaccount that this Credential
+            #   should be associated with. Must be a valid Subaccount of the account issuing the
+            #   request
             # @return [PublicKeyInstance] Newly created PublicKeyInstance
             def create(public_key: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
@@ -172,8 +174,8 @@ module Twilio
             ##
             # Initialize the PublicKeyContext
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PublicKey resource to fetch.
             # @return [PublicKeyContext] PublicKeyContext
             def initialize(version, sid)
               super(version)
@@ -200,8 +202,8 @@ module Twilio
 
             ##
             # Update the PublicKeyInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [PublicKeyInstance] Updated PublicKeyInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -242,8 +244,8 @@ module Twilio
             # Initialize the PublicKeyInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PublicKey resource to fetch.
             # @return [PublicKeyInstance] PublicKeyInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -275,31 +277,31 @@ module Twilio
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] AccountSid the Credential resource belongs to
+            # @return [String] The SID of the Account that created the Credential that the PublicKey resource belongs to
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] A human readable description of this resource
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -319,8 +321,8 @@ module Twilio
 
             ##
             # Update the PublicKeyInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [PublicKeyInstance] Updated PublicKeyInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

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

@@ -122,8 +122,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this API Key.
-      #    You will use this as the basic-auth `user` when authenticating to the API.
+      # @param [String] sid The unique string that that we created to identify the Key
+      #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)
@@ -131,8 +131,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Message resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
@@ -179,8 +179,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Recording resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
       def recordings(sid=:unset)
@@ -217,7 +217,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A unique 34-character string that identifies this resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Transcription resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)

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

@@ -16,7 +16,9 @@ module Twilio
               ##
               # Initialize the DependentPhoneNumberList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+              #   DependentPhoneNumber resource.
               # @param [String] address_sid The unique string that that we created to identify
               #   the Address resource.
               # @return [DependentPhoneNumberList] DependentPhoneNumberList
@@ -156,7 +158,9 @@ module Twilio
               # Initialize the DependentPhoneNumberInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+              #   DependentPhoneNumber resource.
               # @param [String] address_sid The unique string that that we created to identify
               #   the Address resource.
               # @return [DependentPhoneNumberInstance] DependentPhoneNumberInstance
@@ -195,157 +199,157 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The friendly_name
+              # @return [String] The string that you assigned to describe the resource
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [String] The phone_number
+              # @return [String] The phone number in E.164 format
               def phone_number
                 @properties['phone_number']
               end
 
               ##
-              # @return [String] The voice_url
+              # @return [String] The URL we call when the phone number receives a call
               def voice_url
                 @properties['voice_url']
               end
 
               ##
-              # @return [String] The voice_method
+              # @return [String] The HTTP method used with the voice_url
               def voice_method
                 @properties['voice_method']
               end
 
               ##
-              # @return [String] The voice_fallback_method
+              # @return [String] The HTTP method used with voice_fallback_url
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
 
               ##
-              # @return [String] The voice_fallback_url
+              # @return [String] The URL we call when an error occurs in TwiML
               def voice_fallback_url
                 @properties['voice_fallback_url']
               end
 
               ##
-              # @return [Boolean] The voice_caller_id_lookup
+              # @return [Boolean] Whether to lookup the caller's name
               def voice_caller_id_lookup
                 @properties['voice_caller_id_lookup']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The sms_fallback_method
+              # @return [String] The HTTP method used with sms_fallback_url
               def sms_fallback_method
                 @properties['sms_fallback_method']
               end
 
               ##
-              # @return [String] The sms_fallback_url
+              # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
               def sms_fallback_url
                 @properties['sms_fallback_url']
               end
 
               ##
-              # @return [String] The sms_method
+              # @return [String] The HTTP method to use with sms_url
               def sms_method
                 @properties['sms_method']
               end
 
               ##
-              # @return [String] The sms_url
+              # @return [String] The URL we call when the phone number receives an incoming SMS message
               def sms_url
                 @properties['sms_url']
               end
 
               ##
-              # @return [dependent_phone_number.AddressRequirement] The address_requirements
+              # @return [dependent_phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio
               def address_requirements
                 @properties['address_requirements']
               end
 
               ##
-              # @return [Hash] The capabilities
+              # @return [Hash] Indicate if a phone can receive calls or messages
               def capabilities
                 @properties['capabilities']
               end
 
               ##
-              # @return [String] The status_callback
+              # @return [String] The URL to send status information to your application
               def status_callback
                 @properties['status_callback']
               end
 
               ##
-              # @return [String] The status_callback_method
+              # @return [String] The HTTP method we use to call status_callback
               def status_callback_method
                 @properties['status_callback_method']
               end
 
               ##
-              # @return [String] The api_version
+              # @return [String] The API version used to start a new TwiML session
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The sms_application_sid
+              # @return [String] The SID of the application that handles SMS messages sent to the phone number
               def sms_application_sid
                 @properties['sms_application_sid']
               end
 
               ##
-              # @return [String] The voice_application_sid
+              # @return [String] The SID of the application that handles calls to the phone number
               def voice_application_sid
                 @properties['voice_application_sid']
               end
 
               ##
-              # @return [String] The trunk_sid
+              # @return [String] The SID of the Trunk that handles calls to the phone number
               def trunk_sid
                 @properties['trunk_sid']
               end
 
               ##
-              # @return [dependent_phone_number.EmergencyStatus] The emergency_status
+              # @return [dependent_phone_number.EmergencyStatus] Whether the phone number is enabled for emergency calling
               def emergency_status
                 @properties['emergency_status']
               end
 
               ##
-              # @return [String] The emergency_address_sid
+              # @return [String] The emergency address configuration to use for emergency calling
               def emergency_address_sid
                 @properties['emergency_address_sid']
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end