twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -51,7 +53,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
@@ -63,7 +65,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],
@@ -83,11 +85,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               AwsPage.new(@version, response, @solution)
             end
 
@@ -105,12 +105,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of AwsInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] credentials The credentials
-            # @param [String] friendly_name The friendly_name
-            # @param [String] account_sid The account_sid
-            # @return [AwsInstance] Newly created AwsInstance
+            # Create the AwsInstance
+            # @param [String] credentials A string that contains the AWS access credentials in
+            #   the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example,
+            #   `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] account_sid The SID of the Subaccount that this Credential
+            #   should be associated with. Must be a valid Subaccount of the account issuing the
+            #   request.
+            # @return [AwsInstance] Created AwsInstance
             def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
                   'Credentials' => credentials,
@@ -118,13 +122,9 @@ module Twilio
                   'AccountSid' => account_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              AwsInstance.new(@version, payload)
+              AwsInstance.new(@version, payload, )
             end
 
             ##
@@ -153,7 +153,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [AwsInstance] AwsInstance
             def get_instance(payload)
-              AwsInstance.new(@version, payload)
+              AwsInstance.new(@version, payload, )
             end
 
             ##
@@ -167,52 +167,44 @@ module Twilio
             ##
             # Initialize the AwsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The sid
+            # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+            #   resource to fetch.
             # @return [AwsContext] AwsContext
             def initialize(version, sid)
               super(version)
 
               # Path Solution
-              @solution = {sid: sid}
+              @solution = {sid: sid, }
               @uri = "/Credentials/AWS/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a AwsInstance
+            # Fetch the AwsInstance
             # @return [AwsInstance] Fetched AwsInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              AwsInstance.new(@version, payload, sid: @solution[:sid])
+              AwsInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              AwsInstance.new(@version, payload, sid: @solution[:sid])
+              AwsInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the AwsInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the AwsInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -221,6 +213,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Accounts.V1.AwsContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Accounts.V1.AwsContext #{context}>"
+            end
           end
 
           class AwsInstance < InstanceResource
@@ -228,7 +227,8 @@ module Twilio
             # Initialize the AwsInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The sid
+            # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+            #   resource to fetch.
             # @return [AwsInstance] AwsInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -245,7 +245,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'sid' => sid || @properties['sid']}
+              @params = {'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -254,49 +254,49 @@ module Twilio
             # @return [AwsContext] AwsContext for this AwsInstance
             def context
               unless @instance_context
-                @instance_context = AwsContext.new(@version, @params['sid'])
+                @instance_context = AwsContext.new(@version, @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 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 URI for this resource, relative to `https://accounts.twilio.com`
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a AwsInstance
+            # Fetch the AwsInstance
             # @return [AwsInstance] Fetched AwsInstance
             def fetch
               context.fetch
@@ -304,15 +304,16 @@ module Twilio
 
             ##
             # Update the AwsInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [AwsInstance] Updated AwsInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the AwsInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the AwsInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -51,7 +53,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
@@ -63,7 +65,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],
@@ -83,11 +85,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               PublicKeyPage.new(@version, response, @solution)
             end
 
@@ -105,15 +105,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PublicKeyInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] public_key URL encoded representation of the public key, e.g.
-            #   -----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
-            # @param [String] account_sid The Subaccount this Credential should be associated
-            #   with. Needs to be a valid Subaccount of the account issuing the request
-            # @return [PublicKeyInstance] Newly created PublicKeyInstance
+            # Create the PublicKeyInstance
+            # @param [String] public_key A URL encoded representation of the public key. For
+            #   example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC
+            #   KEY-----`
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] account_sid The SID of the Subaccount that this Credential
+            #   should be associated with. Must be a valid Subaccount of the account issuing the
+            #   request
+            # @return [PublicKeyInstance] Created PublicKeyInstance
             def create(public_key: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
                   'PublicKey' => public_key,
@@ -121,13 +122,9 @@ module Twilio
                   'AccountSid' => account_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              PublicKeyInstance.new(@version, payload)
+              PublicKeyInstance.new(@version, payload, )
             end
 
             ##
@@ -156,7 +153,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [PublicKeyInstance] PublicKeyInstance
             def get_instance(payload)
-              PublicKeyInstance.new(@version, payload)
+              PublicKeyInstance.new(@version, payload, )
             end
 
             ##
@@ -170,54 +167,44 @@ module Twilio
             ##
             # Initialize the PublicKeyContext
             # @param [Version] version Version that contains the resource
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PublicKey resource to fetch.
             # @return [PublicKeyContext] PublicKeyContext
             def initialize(version, sid)
               super(version)
 
               # Path Solution
-              @solution = {sid: sid}
+              @solution = {sid: sid, }
               @uri = "/Credentials/PublicKeys/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a PublicKeyInstance
+            # Fetch the PublicKeyInstance
             # @return [PublicKeyInstance] Fetched PublicKeyInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              PublicKeyInstance.new(@version, payload, sid: @solution[:sid])
+              PublicKeyInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
             # Update the PublicKeyInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [PublicKeyInstance] Updated PublicKeyInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              PublicKeyInstance.new(@version, payload, sid: @solution[:sid])
+              PublicKeyInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the PublicKeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the PublicKeyInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -226,6 +213,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Accounts.V1.PublicKeyContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Accounts.V1.PublicKeyContext #{context}>"
+            end
           end
 
           class PublicKeyInstance < InstanceResource
@@ -233,8 +227,8 @@ module Twilio
             # Initialize the PublicKeyInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sid The Credential Sid that uniquely identifies the Credential
-            #   to fetch
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   PublicKey resource to fetch.
             # @return [PublicKeyInstance] PublicKeyInstance
             def initialize(version, payload, sid: nil)
               super(version)
@@ -251,7 +245,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'sid' => sid || @properties['sid']}
+              @params = {'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -260,37 +254,37 @@ module Twilio
             # @return [PublicKeyContext] PublicKeyContext for this PublicKeyInstance
             def context
               unless @instance_context
-                @instance_context = PublicKeyContext.new(@version, @params['sid'])
+                @instance_context = PublicKeyContext.new(@version, @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] AccountSid the Credential resource belongs to
+            # @return [String] The SID of the Account that created the Credential that the PublicKey resource belongs to
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] A human readable description of this resource
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
@@ -302,7 +296,7 @@ module Twilio
             end
 
             ##
-            # Fetch a PublicKeyInstance
+            # Fetch the PublicKeyInstance
             # @return [PublicKeyInstance] Fetched PublicKeyInstance
             def fetch
               context.fetch
@@ -310,16 +304,16 @@ module Twilio
 
             ##
             # Update the PublicKeyInstance
-            # @param [String] friendly_name A human readable description of this resource, up
-            #   to 64 characters.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [PublicKeyInstance] Updated PublicKeyInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the PublicKeyInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the PublicKeyInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/accounts/v1/credential.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -26,33 +28,34 @@ module Twilio
 
           ##
           # Access the public_key
-          # @param [String] sid The Credential Sid that uniquely identifies the Credential
-          #   to fetch
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   PublicKey resource to fetch.
           # @return [PublicKeyList]
           # @return [PublicKeyContext] if sid was passed.
           def public_key(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return PublicKeyContext.new(@version, sid)
+              return PublicKeyContext.new(@version, sid, )
             end
 
-              @public_key ||= PublicKeyList.new(@version)
+              @public_key ||= PublicKeyList.new(@version, )
           end
 
           ##
           # Access the aws
-          # @param [String] sid The sid
+          # @param [String] sid The Twilio-provided string that uniquely identifies the AWS
+          #   resource to fetch.
           # @return [AwsList]
           # @return [AwsContext] if sid was passed.
           def aws(sid=:unset)
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return AwsContext.new(@version, sid)
+              return AwsContext.new(@version, sid, )
             end
 
-              @aws ||= AwsList.new(@version)
+              @aws ||= AwsList.new(@version, )
           end
 
           ##
@@ -81,7 +84,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [CredentialInstance] CredentialInstance
           def get_instance(payload)
-            CredentialInstance.new(@version, payload)
+            CredentialInstance.new(@version, payload, )
           end
 
           ##