twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -52,7 +54,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +66,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -84,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
 
@@ -133,7 +133,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [AvailableAddOnInstance] AvailableAddOnInstance
           def get_instance(payload)
-            AvailableAddOnInstance.new(@version, payload)
+            AvailableAddOnInstance.new(@version, payload, )
           end
 
           ##
@@ -149,14 +149,13 @@ 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)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/AvailableAddOns/#{@solution[:sid]}"
 
             # Dependents
@@ -164,18 +163,12 @@ 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])
+            AvailableAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -186,11 +179,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return AvailableAddOnExtensionContext.new(@version, @solution[:sid], sid)
+              return AvailableAddOnExtensionContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @extensions
-              @extensions = AvailableAddOnExtensionList.new(@version, available_add_on_sid: @solution[:sid])
+              @extensions = AvailableAddOnExtensionList.new(@version, available_add_on_sid: @solution[:sid], )
             end
 
             @extensions
@@ -202,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
 
         ##
@@ -211,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)
@@ -230,7 +229,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -239,55 +238,55 @@ module Twilio
           # @return [AvailableAddOnContext] AvailableAddOnContext for this AvailableAddOnInstance
           def context
             unless @instance_context
-              @instance_context = AvailableAddOnContext.new(@version, @params['sid'])
+              @instance_context = AvailableAddOnContext.new(@version, @params['sid'], )
             end
             @instance_context
           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/installed_add_on/installed_add_on_extension.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,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)
@@ -54,7 +57,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -66,7 +69,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -86,11 +89,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               InstalledAddOnExtensionPage.new(@version, response, @solution)
             end
 
@@ -155,28 +156,23 @@ 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)
 
               # Path Solution
-              @solution = {installed_add_on_sid: installed_add_on_sid, sid: sid}
+              @solution = {installed_add_on_sid: installed_add_on_sid, sid: sid, }
               @uri = "/InstalledAddOns/#{@solution[:installed_add_on_sid]}/Extensions/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a InstalledAddOnExtensionInstance
+            # Fetch the InstalledAddOnExtensionInstance
             # @return [InstalledAddOnExtensionInstance] Fetched InstalledAddOnExtensionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               InstalledAddOnExtensionInstance.new(
                   @version,
@@ -188,16 +184,12 @@ 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})
+              data = Twilio::Values.of({'Enabled' => enabled, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               InstalledAddOnExtensionInstance.new(
                   @version,
@@ -213,6 +205,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Marketplace.InstalledAddOnExtensionContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Marketplace.InstalledAddOnExtensionContext #{context}>"
+            end
           end
 
           ##
@@ -222,8 +221,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)
@@ -241,7 +241,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'installed_add_on_sid' => installed_add_on_sid, 'sid' => sid || @properties['sid']}
+              @params = {'installed_add_on_sid' => installed_add_on_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -260,49 +260,49 @@ 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
 
             ##
-            # Fetch a InstalledAddOnExtensionInstance
+            # Fetch the InstalledAddOnExtensionInstance
             # @return [InstalledAddOnExtensionInstance] Fetched InstalledAddOnExtensionInstance
             def fetch
               context.fetch
@@ -310,10 +310,10 @@ 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)
+              context.update(enabled: enabled, )
             end
 
             ##