twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,8 +17,10 @@ module Twilio
                 ##
                 # Initialize the CredentialList
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] credential_list_sid The credential_list_sid
+                # @param [String] account_sid The unique id of the Account that is responsible for
+                #   this resource.
+                # @param [String] credential_list_sid The unique id that identifies the credential
+                #   list that includes this credential.
                 # @return [CredentialList] CredentialList
                 def initialize(version, account_sid: nil, credential_list_sid: nil)
                   super(version)
@@ -55,7 +59,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
@@ -67,7 +71,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],
@@ -87,11 +91,9 @@ module Twilio
                       'Page' => page_number,
                       'PageSize' => page_size,
                   })
-                  response = @version.page(
-                      'GET',
-                      @uri,
-                      params
-                  )
+
+                  response = @version.page('GET', @uri, params: params)
+
                   CredentialPage.new(@version, response, @solution)
                 end
 
@@ -109,19 +111,18 @@ module Twilio
                 end
 
                 ##
-                # Retrieve a single page of CredentialInstance records from the API.
-                # Request is executed immediately.
-                # @param [String] username The username
-                # @param [String] password The password
-                # @return [CredentialInstance] Newly created CredentialInstance
+                # Create the CredentialInstance
+                # @param [String] username The username that will be passed when authenticating
+                #   SIP requests. The username should be sent in response to Twilio's challenge of
+                #   the initial INVITE. It can be up to 32 characters long.
+                # @param [String] password The password that the username will use when
+                #   authenticating SIP requests. The password must be a minimum of 12 characters,
+                #   contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
+                # @return [CredentialInstance] Created CredentialInstance
                 def create(username: nil, password: nil)
-                  data = Twilio::Values.of({'Username' => username, 'Password' => password})
+                  data = Twilio::Values.of({'Username' => username, 'Password' => password, })
 
-                  payload = @version.create(
-                      'POST',
-                      @uri,
-                      data: data
-                  )
+                  payload = @version.create('POST', @uri, data: data)
 
                   CredentialInstance.new(
                       @version,
@@ -176,29 +177,25 @@ module Twilio
                 ##
                 # Initialize the CredentialContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] account_sid The account_sid
-                # @param [String] credential_list_sid The credential_list_sid
-                # @param [String] sid The sid
+                # @param [String] account_sid The unique id of the Account that is responsible for
+                #   this resource.
+                # @param [String] credential_list_sid The unique id that identifies the credential
+                #   list that contains the desired credential.
+                # @param [String] sid The unique id that identifies the resource to fetch.
                 # @return [CredentialContext] CredentialContext
                 def initialize(version, account_sid, credential_list_sid, sid)
                   super(version)
 
                   # Path Solution
-                  @solution = {account_sid: account_sid, credential_list_sid: credential_list_sid, sid: sid}
+                  @solution = {account_sid: account_sid, credential_list_sid: credential_list_sid, sid: sid, }
                   @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:credential_list_sid]}/Credentials/#{@solution[:sid]}.json"
                 end
 
                 ##
-                # Fetch a CredentialInstance
+                # Fetch the CredentialInstance
                 # @return [CredentialInstance] Fetched CredentialInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   CredentialInstance.new(
                       @version,
@@ -211,16 +208,14 @@ module Twilio
 
                 ##
                 # Update the CredentialInstance
-                # @param [String] password The password
+                # @param [String] password The password that the username will use when
+                #   authenticating SIP requests. The password must be a minimum of 12 characters,
+                #   contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
                 # @return [CredentialInstance] Updated CredentialInstance
                 def update(password: :unset)
-                  data = Twilio::Values.of({'Password' => password})
+                  data = Twilio::Values.of({'Password' => password, })
 
-                  payload = @version.update(
-                      'POST',
-                      @uri,
-                      data: data,
-                  )
+                  payload = @version.update('POST', @uri, data: data)
 
                   CredentialInstance.new(
                       @version,
@@ -232,10 +227,10 @@ module Twilio
                 end
 
                 ##
-                # Deletes the CredentialInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the CredentialInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
-                  @version.delete('delete', @uri)
+                   @version.delete('DELETE', @uri)
                 end
 
                 ##
@@ -244,6 +239,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Api.V2010.CredentialContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Api.V2010.CredentialContext #{context}>"
+                end
               end
 
               class CredentialInstance < InstanceResource
@@ -251,9 +253,11 @@ module Twilio
                 # Initialize the CredentialInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] account_sid The account_sid
-                # @param [String] credential_list_sid The credential_list_sid
-                # @param [String] sid The sid
+                # @param [String] account_sid The unique id of the Account that is responsible for
+                #   this resource.
+                # @param [String] credential_list_sid The unique id that identifies the credential
+                #   list that includes this credential.
+                # @param [String] sid The unique id that identifies the resource to fetch.
                 # @return [CredentialInstance] CredentialInstance
                 def initialize(version, payload, account_sid: nil, credential_list_sid: nil, sid: nil)
                   super(version)
@@ -295,49 +299,49 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The sid
+                # @return [String] A 34 character string that uniquely identifies this resource.
                 def sid
                   @properties['sid']
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] The unique id of the Account that is responsible for this resource.
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [String] The credential_list_sid
+                # @return [String] The unique id that identifies the credential list that includes this credential
                 def credential_list_sid
                   @properties['credential_list_sid']
                 end
 
                 ##
-                # @return [String] The username
+                # @return [String] The username for this credential.
                 def username
                   @properties['username']
                 end
 
                 ##
-                # @return [Time] The date_created
+                # @return [Time] The date that this resource was created, given as GMT in RFC 2822 format.
                 def date_created
                   @properties['date_created']
                 end
 
                 ##
-                # @return [Time] The date_updated
+                # @return [Time] The date that this resource was last updated, given as GMT in RFC 2822 format.
                 def date_updated
                   @properties['date_updated']
                 end
 
                 ##
-                # @return [String] The uri
+                # @return [String] The URI for this resource, relative to https://api.twilio.com
                 def uri
                   @properties['uri']
                 end
 
                 ##
-                # Fetch a CredentialInstance
+                # Fetch the CredentialInstance
                 # @return [CredentialInstance] Fetched CredentialInstance
                 def fetch
                   context.fetch
@@ -345,15 +349,17 @@ module Twilio
 
                 ##
                 # Update the CredentialInstance
-                # @param [String] password The password
+                # @param [String] password The password that the username will use when
+                #   authenticating SIP requests. The password must be a minimum of 12 characters,
+                #   contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)
                 # @return [CredentialInstance] Updated CredentialInstance
                 def update(password: :unset)
-                  context.update(password: password)
+                  context.update(password: password, )
                 end
 
                 ##
-                # Deletes the CredentialInstance
-                # @return [Boolean] true if delete succeeds, true otherwise
+                # Delete the CredentialInstance
+                # @return [Boolean] true if delete succeeds, false otherwise
                 def delete
                   context.delete
                 end

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -54,7 +56,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 +68,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 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 CredentialListPage.new(@version, response, @solution)
               end
 
@@ -108,20 +108,16 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of CredentialListInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] friendly_name The friendly_name
-              # @return [CredentialListInstance] Newly created CredentialListInstance
+              # Create the CredentialListInstance
+              # @param [String] friendly_name A human readable descriptive text that describes
+              #   the CredentialList, up to 64 characters long.
+              # @return [CredentialListInstance] Created CredentialListInstance
               def create(friendly_name: nil)
-                data = Twilio::Values.of({'FriendlyName' => friendly_name})
+                data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
-                CredentialListInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                CredentialListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -150,7 +146,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [CredentialListInstance] CredentialListInstance
               def get_instance(payload)
-                CredentialListInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                CredentialListInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -164,14 +160,16 @@ module Twilio
               ##
               # Initialize the CredentialListContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The credential Sid that uniquely identifies this resource
+              # @param [String] account_sid The unique id of the Account that is responsible for
+              #   this resource.
+              # @param [String] sid The credential list Sid that uniquely identifies this
+              #   resource
               # @return [CredentialListContext] CredentialListContext
               def initialize(version, account_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, sid: sid}
+                @solution = {account_sid: account_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/CredentialLists/#{@solution[:sid]}.json"
 
                 # Dependents
@@ -179,16 +177,10 @@ module Twilio
               end
 
               ##
-              # Fetch a CredentialListInstance
+              # Fetch the CredentialListInstance
               # @return [CredentialListInstance] Fetched CredentialListInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 CredentialListInstance.new(
                     @version,
@@ -200,16 +192,13 @@ module Twilio
 
               ##
               # Update the CredentialListInstance
-              # @param [String] friendly_name The friendly_name
+              # @param [String] friendly_name A human readable descriptive text for a
+              #   CredentialList, up to 64 characters long.
               # @return [CredentialListInstance] Updated CredentialListInstance
               def update(friendly_name: nil)
-                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)
 
                 CredentialListInstance.new(
                     @version,
@@ -220,10 +209,10 @@ module Twilio
               end
 
               ##
-              # Deletes the CredentialListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the CredentialListInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -234,7 +223,7 @@ module Twilio
                 raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
                 if sid != :unset
-                  return CredentialContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                  return CredentialContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
                 end
 
                 unless @credentials
@@ -254,6 +243,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.CredentialListContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.CredentialListContext #{context}>"
+              end
             end
 
             class CredentialListInstance < InstanceResource
@@ -263,7 +259,8 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The credential Sid that uniquely identifies this resource
+              # @param [String] sid The credential list Sid that uniquely identifies this
+              #   resource
               # @return [CredentialListInstance] CredentialListInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -281,7 +278,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -290,7 +287,7 @@ module Twilio
               # @return [CredentialListContext] CredentialListContext for this CredentialListInstance
               def context
                 unless @instance_context
-                  @instance_context = CredentialListContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = CredentialListContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
@@ -314,7 +311,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The friendly_name
+              # @return [String] Human readable descriptive text
               def friendly_name
                 @properties['friendly_name']
               end
@@ -326,7 +323,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The subresource_uris
+              # @return [String] The list of credentials associated with this credential list.
               def subresource_uris
                 @properties['subresource_uris']
               end
@@ -338,7 +335,7 @@ module Twilio
               end
 
               ##
-              # Fetch a CredentialListInstance
+              # Fetch the CredentialListInstance
               # @return [CredentialListInstance] Fetched CredentialListInstance
               def fetch
                 context.fetch
@@ -346,15 +343,16 @@ module Twilio
 
               ##
               # Update the CredentialListInstance
-              # @param [String] friendly_name The friendly_name
+              # @param [String] friendly_name A human readable descriptive text for a
+              #   CredentialList, up to 64 characters long.
               # @return [CredentialListInstance] Updated CredentialListInstance
               def update(friendly_name: nil)
-                context.update(friendly_name: friendly_name)
+                context.update(friendly_name: friendly_name, )
               end
 
               ##
-              # Deletes the CredentialListInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the CredentialListInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end