twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/framework/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     # Page Base Class
@@ -29,7 +31,7 @@ module Twilio
 
       def process_response(response)
         if response.status_code != 200
-          raise Twilio::REST::TwilioError.new('Unable to fetch page', response)
+          raise Twilio::REST::RestError.new('Unable to fetch page', response)
         end
 
         response.body

data/lib/twilio-ruby/framework/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Request
     attr_reader :host, :port, :method, :url, :params, :data, :headers, :auth, :timeout

data/lib/twilio-ruby/framework/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class ListResource

data/lib/twilio-ruby/framework/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Response
     attr_accessor :status_code, :body, :headers

data/lib/twilio-ruby/framework/serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   def self.serialize_iso8601_date(date)
     if date.eql?(:unset)

data/lib/twilio-ruby/framework/twilio_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class TwilioResponse
     attr_accessor :status_code, :body

data/lib/twilio-ruby/framework/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Values
     def self.of(hash)

data/lib/twilio-ruby/framework/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class Version
@@ -52,16 +54,7 @@ module Twilio
       end
 
       def exception(response, header)
-        message = header
-        code = response.status_code
-
-        if response.body.key?('message')
-          message += ": #{response.body['message']}"
-        end
-
-        code = response.body['code'] if response.body.key?('code')
-
-        Twilio::REST::RestError.new(message, code, response.status_code)
+        Twilio::REST::RestError.new(header, response)
       end
 
       def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)

data/lib/twilio-ruby/http/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module Twilio
@@ -6,12 +8,11 @@ module Twilio
       attr_accessor :adapter
       attr_reader :timeout, :last_response, :last_request
 
-      def initialize(proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil, ssl_ca_file = nil,
-                     timeout: nil)
-        @proxy_addr = proxy_addr
-        @proxy_port = proxy_port
-        @proxy_user = proxy_user
-        @proxy_pass = proxy_pass
+      def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil,
+                     ssl_ca_file = nil, timeout: nil)
+        @proxy_prot = proxy_prot
+        @proxy_path = "#{proxy_addr}:#{proxy_port}" if proxy_addr && proxy_port
+        @proxy_auth = "#{proxy_user}:#{proxy_pass}@" if proxy_pass && proxy_user
         @ssl_ca_file = ssl_ca_file
         @timeout = timeout
         @adapter = Faraday.default_adapter
@@ -24,19 +25,15 @@ module Twilio
           f.adapter @adapter
           f.headers = request.headers
           f.basic_auth(request.auth[0], request.auth[1])
-          if @proxy_addr
-            f.proxy "#{@proxy_user}:#{@proxy_pass}@#{@proxy_addr}:#{@proxy_port}"
-          end
+          f.proxy = "#{@proxy_prot}://#{@proxy_auth}#{@proxy_path}" if @proxy_prot && @proxy_path
           f.options.open_timeout = request.timeout || @timeout
           f.options.timeout = request.timeout || @timeout
         end
 
         @last_request = request
         @last_response = nil
-        response = @connection.send(request.method.downcase.to_sym,
-                                    request.url,
-                                    request.method == 'GET' ? request.params : request.data)
 
+        response = send(request)
         if response.body && !response.body.empty?
           object = response.body
         elsif response.status == 400
@@ -49,6 +46,14 @@ module Twilio
         twilio_response
       end
 
+      def send(request)
+        @connection.send(request.method.downcase.to_sym,
+                         request.url,
+                         request.method == 'GET' ? request.params : request.data)
+      rescue Faraday::Error => e
+        raise Twilio::REST::TwilioError, e
+      end
+
       def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
         request = Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
         _request(request)

data/lib/twilio-ruby/jwt/access_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module AccessTokenGrant
@@ -144,7 +146,8 @@ module Twilio
 
       class VoiceGrant
         include AccessTokenGrant
-        attr_accessor :outgoing_application_sid,
+        attr_accessor :incoming_allow,
+                      :outgoing_application_sid,
                       :outgoing_application_params,
                       :push_credential_sid,
                       :endpoint_id
@@ -155,6 +158,7 @@ module Twilio
 
         def _generate_payload
           payload = {}
+          payload[:incoming] = { allow: true } if incoming_allow == true
 
           if outgoing_application_sid
             outgoing = {}

data/lib/twilio-ruby/jwt/client_capability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module Scope
@@ -68,7 +70,7 @@ module Twilio
             client_name = "clientName=#{CGI.escape(@client_name)}"
           end
           unless @params.empty?
-            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join('&')
+            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join(CGI.escape('&'))
           end
 
           suffix = [application_sid, client_name, params].compact.join('&')

data/lib/twilio-ruby/jwt/jwt.rb

@@ -1,5 +1,13 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
 module Twilio
   module JWT
+    autoload :AccessToken, File.join(File.dirname(__FILE__), 'access_token.rb')
+    autoload :ClientCapability, File.join(File.dirname(__FILE__), 'client_capability.rb')
+    autoload :TaskRouterCapability, File.join(File.dirname(__FILE__), 'task_router.rb')
+
     class BaseJWT
       # valid_until overrides ttl if specified
       def initialize(secret_key: nil, issuer: nil, subject: nil, nbf: nil, ttl: 3600, valid_until: nil)

data/lib/twilio-ruby/jwt/task_router.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     class TaskRouterCapability < BaseJWT
@@ -82,8 +84,8 @@ module Twilio
           [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces'].join('/')
         end
 
-        def self.workspace(worskspace_sid)
-          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', worskspace_sid].join('/')
+        def self.workspace(workspace_sid)
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', workspace_sid].join('/')
         end
 
         def self.all_workspaces

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],
@@ -107,9 +109,14 @@ module Twilio
             ##
             # 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
+            # @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] Newly created AwsInstance
             def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
@@ -124,7 +131,7 @@ module Twilio
                   data: data
               )
 
-              AwsInstance.new(@version, payload)
+              AwsInstance.new(@version, payload, )
             end
 
             ##
@@ -153,7 +160,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,13 +174,14 @@ 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
 
@@ -189,15 +197,16 @@ module Twilio
                   params,
               )
 
-              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',
@@ -205,12 +214,12 @@ module Twilio
                   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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -221,6 +230,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 +244,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 +262,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'sid' => sid || @properties['sid']}
+              @params = {'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -254,43 +271,43 @@ 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
@@ -304,15 +321,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
+            # @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],
@@ -107,12 +109,14 @@ module Twilio
             ##
             # 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
+            # @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] Newly created PublicKeyInstance
             def create(public_key: nil, friendly_name: :unset, account_sid: :unset)
               data = Twilio::Values.of({
@@ -127,7 +131,7 @@ module Twilio
                   data: data
               )
 
-              PublicKeyInstance.new(@version, payload)
+              PublicKeyInstance.new(@version, payload, )
             end
 
             ##
@@ -156,7 +160,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,14 +174,14 @@ 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
 
@@ -193,16 +197,16 @@ module Twilio
                   params,
               )
 
-              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',
@@ -210,12 +214,12 @@ module Twilio
                   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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -226,6 +230,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 +244,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 +262,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'sid' => sid || @properties['sid']}
+              @params = {'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -260,37 +271,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
@@ -310,16 +321,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
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end