twilio-ruby 5.6.0 → 5.33.1

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
@@ -26,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({
@@ -49,7 +50,7 @@ module Twilio
                 data: data
             )
 
-            InstalledAddOnInstance.new(@version, payload)
+            InstalledAddOnInstance.new(@version, payload, )
           end
 
           ##
@@ -81,7 +82,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 +94,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],
@@ -162,7 +163,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 +179,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
@@ -194,7 +194,7 @@ module Twilio
 
           ##
           # Deletes the InstalledAddOnInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -211,15 +211,16 @@ module Twilio
                 params,
             )
 
-            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({
@@ -233,7 +234,7 @@ module Twilio
                 data: data,
             )
 
-            InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid])
+            InstalledAddOnInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -244,11 +245,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 +261,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 +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)
@@ -291,7 +298,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -300,74 +307,74 @@ 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
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
@@ -381,13 +388,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,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)
@@ -33,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/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],
@@ -170,7 +172,7 @@ 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
 
@@ -197,7 +199,7 @@ module Twilio
 
               ##
               # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -212,7 +214,7 @@ 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',
@@ -235,6 +237,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
 
             ##
@@ -348,7 +357,7 @@ module Twilio
 
               ##
               # Deletes the DocumentPermissionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
@@ -363,7 +372,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
 
               ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -32,7 +34,7 @@ module Twilio
             # @param [Hash] data The data
             # @return [DocumentInstance] Newly created DocumentInstance
             def create(unique_name: :unset, data: :unset)
-              data = Twilio::Values.of({'UniqueName' => unique_name, 'Data' => Twilio.serialize_object(data)})
+              data = Twilio::Values.of({'UniqueName' => unique_name, 'Data' => Twilio.serialize_object(data), })
 
               payload = @version.create(
                   'POST',
@@ -40,7 +42,7 @@ module Twilio
                   data: data
               )
 
-              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -72,7 +74,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
@@ -84,7 +86,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],
@@ -153,7 +155,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [DocumentInstance] DocumentInstance
             def get_instance(payload)
-              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -176,7 +178,7 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"
 
               # Dependents
@@ -195,12 +197,12 @@ module Twilio
                   params,
               )
 
-              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the DocumentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -210,7 +212,7 @@ module Twilio
             # @param [Hash] data The data
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: nil)
-              data = Twilio::Values.of({'Data' => Twilio.serialize_object(data)})
+              data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
 
               payload = @version.update(
                   'POST',
@@ -218,7 +220,7 @@ module Twilio
                   data: data,
               )
 
-              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -229,7 +231,7 @@ module Twilio
               raise ArgumentError, 'identity cannot be nil' if identity.nil?
 
               if identity != :unset
-                return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity)
+                return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
               end
 
               unless @document_permissions
@@ -249,6 +251,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.Sync.DocumentContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Sync.DocumentContext #{context}>"
+            end
           end
 
           ##
@@ -281,7 +290,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -290,7 +299,7 @@ module Twilio
             # @return [DocumentContext] DocumentContext for this DocumentInstance
             def context
               unless @instance_context
-                @instance_context = DocumentContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = DocumentContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
@@ -370,7 +379,7 @@ module Twilio
 
             ##
             # Deletes the DocumentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -380,7 +389,7 @@ module Twilio
             # @param [Hash] data The data
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: nil)
-              context.update(data: data)
+              context.update(data: data, )
             end
 
             ##

data/lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -33,7 +35,7 @@ module Twilio
               # @param [Hash] data The data
               # @return [SyncListItemInstance] Newly created SyncListItemInstance
               def create(data: nil)
-                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data)})
+                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
 
                 payload = @version.create(
                     'POST',
@@ -84,7 +86,7 @@ module Twilio
               def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size])
+                page = self.page(order: order, from: from, bounds: bounds, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -96,7 +98,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],
@@ -200,7 +202,7 @@ module Twilio
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, list_sid: list_sid, index: index}
+                @solution = {service_sid: service_sid, list_sid: list_sid, index: index, }
                 @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Items/#{@solution[:index]}"
               end
 
@@ -227,7 +229,7 @@ module Twilio
 
               ##
               # Deletes the SyncListItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -237,7 +239,7 @@ module Twilio
               # @param [Hash] data The data
               # @return [SyncListItemInstance] Updated SyncListItemInstance
               def update(data: nil)
-                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data)})
+                data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
 
                 payload = @version.update(
                     'POST',
@@ -260,6 +262,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Preview.Sync.SyncListItemContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Sync.SyncListItemContext #{context}>"
+              end
             end
 
             ##
@@ -384,7 +393,7 @@ module Twilio
 
               ##
               # Deletes the SyncListItemInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
@@ -394,7 +403,7 @@ module Twilio
               # @param [Hash] data The data
               # @return [SyncListItemInstance] Updated SyncListItemInstance
               def update(data: nil)
-                context.update(data: data)
+                context.update(data: data, )
               end
 
               ##