twilio-ruby 5.29.0 → 5.29.1

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

@@ -128,7 +128,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
+      # @param [String] sid The unique string that we created to identify the
+      #   AvailableAddOn resource.
       # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
       # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
       def available_add_ons(sid=:unset)
@@ -136,9 +137,9 @@ module Twilio
       end
 
       ##
-      # @param [String] sid 34 character string that uniquely identifies the Add-on.
-      #   This Sid can also be found in the Console on that specific Add-ons page as the
-      #   'Available Add-on Sid'.
+      # @param [String] sid The unique string that we created to identify the
+      #   InstalledAddOn resource. This Sid can also be found in the Console on that
+      #   specific Add-ons page as the 'Available Add-on Sid'.
       # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnInstance] if sid was passed.
       # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
       def installed_add_ons(sid=:unset)

data/lib/twilio-ruby/rest/preview/marketplace.rb

@@ -20,8 +20,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
-        #   resource
+        # @param [String] sid The SID of the AvailableAddOn resource to fetch.
         # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
         # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
         def available_add_ons(sid=:unset)
@@ -35,8 +34,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
-        #   resource
+        # @param [String] sid The SID of the InstalledAddOn resource to fetch.
         # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
         # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
         def installed_add_ons(sid=:unset)

data/lib/twilio-ruby/rest/preview/marketplace/available_add_on.rb

@@ -151,8 +151,7 @@ module Twilio
           ##
           # Initialize the AvailableAddOnContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The Available Add-on Sid that uniquely identifies this
-          #   resource
+          # @param [String] sid The SID of the AvailableAddOn resource to fetch.
           # @return [AvailableAddOnContext] AvailableAddOnContext
           def initialize(version, sid)
             super(version)
@@ -220,8 +219,7 @@ module Twilio
           # Initialize the AvailableAddOnInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The Available Add-on Sid that uniquely identifies this
-          #   resource
+          # @param [String] sid The SID of the AvailableAddOn resource to fetch.
           # @return [AvailableAddOnInstance] AvailableAddOnInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -254,43 +252,43 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Add-on
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] A description of this Add-on
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] A short description of the Add-on functionality
+          # @return [String] A short description of the Add-on's functionality
           def description
             @properties['description']
           end
 
           ##
-          # @return [String] The way customers are charged for using this Add-on
+          # @return [String] How customers are charged for using this Add-on
           def pricing_type
             @properties['pricing_type']
           end
 
           ##
-          # @return [Hash] The JSON Schema describing the Add-on's configuration
+          # @return [Hash] The JSON object with the configuration that must be provided when installing a given Add-on
           def configuration_schema
             @properties['configuration_schema']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/preview/marketplace/available_add_on/available_add_on_extension.rb

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the AvailableAddOnExtensionList
             # @param [Version] version Version that contains the resource
-            # @param [String] available_add_on_sid The available_add_on_sid
+            # @param [String] available_add_on_sid The SID of the AvailableAddOn resource to
+            #   which this extension applies.
             # @return [AvailableAddOnExtensionList] AvailableAddOnExtensionList
             def initialize(version, available_add_on_sid: nil)
               super(version)
@@ -157,8 +158,9 @@ module Twilio
             ##
             # Initialize the AvailableAddOnExtensionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] available_add_on_sid The available_add_on_sid
-            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @param [String] available_add_on_sid The SID of the AvailableAddOn resource with
+            #   the extension to fetch.
+            # @param [String] sid The SID of the AvailableAddOn Extension resource to fetch.
             # @return [AvailableAddOnExtensionContext] AvailableAddOnExtensionContext
             def initialize(version, available_add_on_sid, sid)
               super(version)
@@ -210,8 +212,9 @@ module Twilio
             # Initialize the AvailableAddOnExtensionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] available_add_on_sid The available_add_on_sid
-            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @param [String] available_add_on_sid The SID of the AvailableAddOn resource to
+            #   which this extension applies.
+            # @param [String] sid The SID of the AvailableAddOn Extension resource to fetch.
             # @return [AvailableAddOnExtensionInstance] AvailableAddOnExtensionInstance
             def initialize(version, payload, available_add_on_sid: nil, sid: nil)
               super(version)
@@ -247,37 +250,37 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Extension
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The available_add_on_sid
+            # @return [String] The SID of the AvailableAddOn resource to which this extension applies
             def available_add_on_sid
               @properties['available_add_on_sid']
             end
 
             ##
-            # @return [String] A human-readable description of this Extension
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] A human-readable description of the Extension's Product
+            # @return [String] The name of the Extension's Product
             def product_name
               @properties['product_name']
             end
 
             ##
-            # @return [String] The string that uniquely identifies this Extension
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb

@@ -28,14 +28,13 @@ module Twilio
           ##
           # Retrieve a single page of InstalledAddOnInstance records from the API.
           # Request is executed immediately.
-          # @param [String] available_add_on_sid A 34 character string that uniquely
-          #   identifies the Add-on to be installed.
-          # @param [Boolean] accept_terms_of_service A boolean that reflects your decision
-          #   whether to accept the Terms of Service
-          # @param [Hash] configuration The JSON object representing the configuration of
-          #   the new Add-on installation.
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Add-on installation for an Account.
+          # @param [String] available_add_on_sid The SID of the AvaliableAddOn to install.
+          # @param [Boolean] accept_terms_of_service Whether the Terms of Service were
+          #   accepted.
+          # @param [Hash] configuration The JSON object that represents the configuration of
+          #   the new Add-on being installed.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be unique within the Account.
           # @return [InstalledAddOnInstance] Newly created InstalledAddOnInstance
           def create(available_add_on_sid: nil, accept_terms_of_service: nil, configuration: :unset, unique_name: :unset)
             data = Twilio::Values.of({
@@ -180,8 +179,7 @@ module Twilio
           ##
           # Initialize the InstalledAddOnContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The Installed Add-on Sid that uniquely identifies this
-          #   resource
+          # @param [String] sid The SID of the InstalledAddOn resource to fetch.
           # @return [InstalledAddOnContext] InstalledAddOnContext
           def initialize(version, sid)
             super(version)
@@ -219,10 +217,10 @@ module Twilio
           ##
           # Update the InstalledAddOnInstance
           # @param [Hash] configuration Valid JSON object that conform to the configuration
-          #   schema exposed by the associated Available Add-on resource. This is only
-          #   required by Add-ons that need to be configured
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Add-on installation for an Account.
+          #   schema exposed by the associated AvailableAddOn resource. This is only required
+          #   by Add-ons that need to be configured
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be unique within the Account.
           # @return [InstalledAddOnInstance] Updated InstalledAddOnInstance
           def update(configuration: :unset, unique_name: :unset)
             data = Twilio::Values.of({
@@ -279,8 +277,7 @@ module Twilio
           # Initialize the InstalledAddOnInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The Installed Add-on Sid that uniquely identifies this
-          #   resource
+          # @param [String] sid The SID of the InstalledAddOn resource to fetch.
           # @return [InstalledAddOnInstance] InstalledAddOnInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -316,61 +313,61 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Add-on installation
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The Account id that has installed this Add-on
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] A description of this Add-on installation
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [String] A short description of the Add-on functionality
+          # @return [String] A short description of the Add-on's functionality
           def description
             @properties['description']
           end
 
           ##
-          # @return [Hash] The JSON object representing the current configuration
+          # @return [Hash] The JSON object that represents the current configuration of installed Add-on
           def configuration
             @properties['configuration']
           end
 
           ##
-          # @return [String] The string that uniquely identifies this Add-on installation
+          # @return [String] An application-defined string that uniquely identifies the resource
           def unique_name
             @properties['unique_name']
           end
 
           ##
-          # @return [Time] The date this Add-on installation was created
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date this Add-on installation was last updated
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] A dictionary of URLs for related resource.
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end
@@ -392,10 +389,10 @@ module Twilio
           ##
           # Update the InstalledAddOnInstance
           # @param [Hash] configuration Valid JSON object that conform to the configuration
-          #   schema exposed by the associated Available Add-on resource. This is only
-          #   required by Add-ons that need to be configured
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Add-on installation for an Account.
+          #   schema exposed by the associated AvailableAddOn resource. This is only required
+          #   by Add-ons that need to be configured
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be unique within the Account.
           # @return [InstalledAddOnInstance] Updated InstalledAddOnInstance
           def update(configuration: :unset, unique_name: :unset)
             context.update(configuration: configuration, unique_name: unique_name, )

data/lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the InstalledAddOnExtensionList
             # @param [Version] version Version that contains the resource
-            # @param [String] installed_add_on_sid The installed_add_on_sid
+            # @param [String] installed_add_on_sid The SID of the InstalledAddOn resource to
+            #   which this extension applies.
             # @return [InstalledAddOnExtensionList] InstalledAddOnExtensionList
             def initialize(version, installed_add_on_sid: nil)
               super(version)
@@ -157,8 +158,9 @@ module Twilio
             ##
             # Initialize the InstalledAddOnExtensionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] installed_add_on_sid The installed_add_on_sid
-            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @param [String] installed_add_on_sid The SID of the InstalledAddOn resource with
+            #   the extension to fetch.
+            # @param [String] sid The SID of the InstalledAddOn Extension resource to fetch.
             # @return [InstalledAddOnExtensionContext] InstalledAddOnExtensionContext
             def initialize(version, installed_add_on_sid, sid)
               super(version)
@@ -190,7 +192,7 @@ module Twilio
 
             ##
             # Update the InstalledAddOnExtensionInstance
-            # @param [Boolean] enabled A Boolean indicating if the Extension will be invoked.
+            # @param [Boolean] enabled Whether the Extension should be invoked.
             # @return [InstalledAddOnExtensionInstance] Updated InstalledAddOnExtensionInstance
             def update(enabled: nil)
               data = Twilio::Values.of({'Enabled' => enabled, })
@@ -231,8 +233,9 @@ module Twilio
             # Initialize the InstalledAddOnExtensionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] installed_add_on_sid The installed_add_on_sid
-            # @param [String] sid The Extension Sid that uniquely identifies this resource
+            # @param [String] installed_add_on_sid The SID of the InstalledAddOn resource to
+            #   which this extension applies.
+            # @param [String] sid The SID of the InstalledAddOn Extension resource to fetch.
             # @return [InstalledAddOnExtensionInstance] InstalledAddOnExtensionInstance
             def initialize(version, payload, installed_add_on_sid: nil, sid: nil)
               super(version)
@@ -269,43 +272,43 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Extension
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The installed_add_on_sid
+            # @return [String] The SID of the InstalledAddOn resource to which this extension applies
             def installed_add_on_sid
               @properties['installed_add_on_sid']
             end
 
             ##
-            # @return [String] A human-readable description of this Extension
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] A human-readable description of the Extension's Product
+            # @return [String] The name of the Extension's Product
             def product_name
               @properties['product_name']
             end
 
             ##
-            # @return [String] The string that uniquely identifies this Extension
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [Boolean] A Boolean indicating if the Extension will be invoked
+            # @return [Boolean] Whether the Extension will be invoked
             def enabled
               @properties['enabled']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
@@ -319,7 +322,7 @@ module Twilio
 
             ##
             # Update the InstalledAddOnExtensionInstance
-            # @param [Boolean] enabled A Boolean indicating if the Extension will be invoked.
+            # @param [Boolean] enabled Whether the Extension should be invoked.
             # @return [InstalledAddOnExtensionInstance] Updated InstalledAddOnExtensionInstance
             def update(enabled: nil)
               context.update(enabled: enabled, )

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

@@ -32,9 +32,10 @@ module Twilio
             ##
             # Retrieve a single page of VerificationInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to The phone number to verify. Phone numbers must be in [E.164
-            #   format](https://www.twilio.com/docs/glossary/what-e164).
-            # @param [String] channel The verification method to use. Can be: `sms` or `call`.
+            # @param [String] to The phone number or email to verify. Phone numbers must be in
+            #   [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
+            # @param [String] channel The verification method to use. Can be: `email`, `sms`
+            #   or `call`.
             # @param [String] custom_message The text of a custom message to use for the
             #   verification.
             # @param [String] send_digits The digits to send after a phone call is answered,
@@ -55,8 +56,10 @@ module Twilio
             #   Limits. Keys should be the unique_name configured while creating you Rate Limit
             #   along with the associated values for each particular request. You may include
             #   multiple Rate Limit values in each request.
+            # @param [Hash] channel_configuration Channel specific configuration in json
+            #   format: For email must include 'from' and 'from_name'.
             # @return [VerificationInstance] Newly created VerificationInstance
-            def create(to: nil, channel: nil, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset)
+            def create(to: nil, channel: nil, custom_message: :unset, send_digits: :unset, locale: :unset, custom_code: :unset, amount: :unset, payee: :unset, rate_limits: :unset, channel_configuration: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'Channel' => channel,
@@ -67,6 +70,7 @@ module Twilio
                   'Amount' => amount,
                   'Payee' => payee,
                   'RateLimits' => Twilio.serialize_object(rate_limits),
+                  'ChannelConfiguration' => Twilio.serialize_object(channel_configuration),
               })
 
               payload = @version.create(
@@ -261,7 +265,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The phone number being verified
+            # @return [String] The phone number or email being verified
             def to
               @properties['to']
             end