twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,37 +15,35 @@ module Twilio
         def initialize(domain)
           super
           @version = 'marketplace'
-          @installed_add_ons = nil
           @available_add_ons = nil
+          @installed_add_ons = nil
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
-        #   resource
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
-        def installed_add_ons(sid=:unset)
+        # @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)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+            @available_add_ons ||= AvailableAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+            AvailableAddOnContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
-        #   resource
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-        def available_add_ons(sid=:unset)
+        # @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)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+            @installed_add_ons ||= InstalledAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+            InstalledAddOnContext.new(self, sid)
           end
         end
 

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -86,11 +86,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             AvailableAddOnPage.new(@version, response, @solution)
           end
 
@@ -151,8 +149,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)
@@ -166,16 +163,10 @@ module Twilio
           end
 
           ##
-          # Fetch a AvailableAddOnInstance
+          # Fetch the AvailableAddOnInstance
           # @return [AvailableAddOnInstance] Fetched AvailableAddOnInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             AvailableAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -204,6 +195,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Preview.Marketplace.AvailableAddOnContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.Marketplace.AvailableAddOnContext #{context}>"
+          end
         end
 
         ##
@@ -213,8 +211,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)
@@ -247,49 +244,49 @@ 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
 
           ##
-          # Fetch a AvailableAddOnInstance
+          # Fetch the AvailableAddOnInstance
           # @return [AvailableAddOnInstance] Fetched AvailableAddOnInstance
           def fetch
             context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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)
@@ -88,11 +89,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               AvailableAddOnExtensionPage.new(@version, response, @solution)
             end
 
@@ -157,8 +156,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)
@@ -169,16 +169,10 @@ module Twilio
             end
 
             ##
-            # Fetch a AvailableAddOnExtensionInstance
+            # Fetch the AvailableAddOnExtensionInstance
             # @return [AvailableAddOnExtensionInstance] Fetched AvailableAddOnExtensionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               AvailableAddOnExtensionInstance.new(
                   @version,
@@ -194,6 +188,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Marketplace.AvailableAddOnExtensionContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Marketplace.AvailableAddOnExtensionContext #{context}>"
+            end
           end
 
           ##
@@ -203,8 +204,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)
@@ -240,43 +242,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 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
 
             ##
-            # Fetch a AvailableAddOnExtensionInstance
+            # Fetch the AvailableAddOnExtensionInstance
             # @return [AvailableAddOnExtensionInstance] Fetched AvailableAddOnExtensionInstance
             def fetch
               context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -26,17 +26,15 @@ module Twilio
           end
 
           ##
-          # 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.
-          # @return [InstalledAddOnInstance] Newly created InstalledAddOnInstance
+          # Create the InstalledAddOnInstance
+          # @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] Created InstalledAddOnInstance
           def create(available_add_on_sid: nil, accept_terms_of_service: nil, configuration: :unset, unique_name: :unset)
             data = Twilio::Values.of({
                 'AvailableAddOnSid' => available_add_on_sid,
@@ -45,11 +43,7 @@ module Twilio
                 'UniqueName' => unique_name,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             InstalledAddOnInstance.new(@version, payload, )
           end
@@ -115,11 +109,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             InstalledAddOnPage.new(@version, response, @solution)
           end
 
@@ -180,8 +172,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)
@@ -195,23 +186,17 @@ module Twilio
           end
 
           ##
-          # Deletes the InstalledAddOnInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the InstalledAddOnInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
-          # Fetch a InstalledAddOnInstance
+          # Fetch the InstalledAddOnInstance
           # @return [InstalledAddOnInstance] Fetched InstalledAddOnInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -219,10 +204,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({
@@ -230,11 +215,7 @@ module Twilio
                 'UniqueName' => unique_name,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -263,6 +244,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Preview.Marketplace.InstalledAddOnContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.Marketplace.InstalledAddOnContext #{context}>"
+          end
         end
 
         ##
@@ -272,8 +260,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)
@@ -309,74 +296,74 @@ 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
 
           ##
-          # Deletes the InstalledAddOnInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the InstalledAddOnInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
 
           ##
-          # Fetch a InstalledAddOnInstance
+          # Fetch the InstalledAddOnInstance
           # @return [InstalledAddOnInstance] Fetched InstalledAddOnInstance
           def fetch
             context.fetch
@@ -385,10 +372,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, )