twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -24,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,
@@ -43,13 +43,9 @@ module Twilio
                 'UniqueName' => unique_name,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
-            InstalledAddOnInstance.new(@version, payload)
+            InstalledAddOnInstance.new(@version, payload, )
           end
 
           ##
@@ -81,7 +77,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
@@ -93,7 +89,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],
@@ -113,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
 
@@ -162,7 +156,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [InstalledAddOnInstance] InstalledAddOnInstance
           def get_instance(payload)
-            InstalledAddOnInstance.new(@version, payload)
+            InstalledAddOnInstance.new(@version, payload, )
           end
 
           ##
@@ -178,14 +172,13 @@ 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)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/InstalledAddOns/#{@solution[:sid]}"
 
             # Dependents
@@ -193,33 +186,28 @@ 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])
+            InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the InstalledAddOnInstance
-          # @param [Hash] configuration The JSON object representing the configuration of
-          #   the Add-on installation.
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Add-on installation for an Account.
+          # @param [Hash] configuration Valid JSON object that conform to the configuration
+          #   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({
@@ -227,13 +215,9 @@ 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])
+            InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -244,11 +228,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return InstalledAddOnExtensionContext.new(@version, @solution[:sid], sid)
+              return InstalledAddOnExtensionContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @extensions
-              @extensions = InstalledAddOnExtensionList.new(@version, installed_add_on_sid: @solution[:sid])
+              @extensions = InstalledAddOnExtensionList.new(@version, installed_add_on_sid: @solution[:sid], )
             end
 
             @extensions
@@ -260,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
 
         ##
@@ -269,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)
@@ -291,7 +281,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -300,80 +290,80 @@ module Twilio
           # @return [InstalledAddOnContext] InstalledAddOnContext for this InstalledAddOnInstance
           def context
             unless @instance_context
-              @instance_context = InstalledAddOnContext.new(@version, @params['sid'])
+              @instance_context = InstalledAddOnContext.new(@version, @params['sid'], )
             end
             @instance_context
           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] The links
+          # @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
@@ -381,13 +371,14 @@ module Twilio
 
           ##
           # Update the InstalledAddOnInstance
-          # @param [Hash] configuration The JSON object representing the configuration of
-          #   the Add-on installation.
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Add-on installation for an Account.
+          # @param [Hash] configuration Valid JSON object that conform to the configuration
+          #   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)
+            context.update(configuration: configuration, unique_name: unique_name, )
           end
 
           ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,32 +20,32 @@ 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)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @available_add_ons ||= AvailableAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+              AvailableAddOnContext.new(self, sid)
           end
         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)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @installed_add_ons ||= InstalledAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+              InstalledAddOnContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -58,7 +60,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
@@ -70,7 +72,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],
@@ -90,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 DocumentPermissionPage.new(@version, response, @solution)
               end
 
@@ -170,21 +170,15 @@ module Twilio
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, document_sid: document_sid, identity: identity}
+                @solution = {service_sid: service_sid, document_sid: document_sid, identity: identity, }
                 @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"
               end
 
               ##
-              # Fetch a DocumentPermissionInstance
+              # Fetch the DocumentPermissionInstance
               # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 DocumentPermissionInstance.new(
                     @version,
@@ -196,10 +190,10 @@ module Twilio
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -212,13 +206,9 @@ module Twilio
               #   the Sync Document.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage})
+                data = Twilio::Values.of({'Read' => read, 'Write' => write, 'Manage' => manage, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 DocumentPermissionInstance.new(
                     @version,
@@ -235,6 +225,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Preview.Sync.DocumentPermissionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Sync.DocumentPermissionContext #{context}>"
+              end
             end
 
             ##
@@ -340,15 +337,15 @@ module Twilio
               end
 
               ##
-              # Fetch a DocumentPermissionInstance
+              # Fetch the DocumentPermissionInstance
               # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
@@ -363,7 +360,7 @@ module Twilio
               #   the Sync Document.
               # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
               def update(read: nil, write: nil, manage: nil)
-                context.update(read: read, write: write, manage: manage)
+                context.update(read: read, write: write, manage: manage, )
               end
 
               ##