twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/chat/v2.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,30 +20,32 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Credential resource to fetch.
         # @return [Twilio::REST::Chat::V2::CredentialContext] if sid was passed.
         # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Chat::V2::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/chat.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -34,7 +36,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Credential
+      #   resource.
       # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
       # @return [Twilio::REST::Chat::V2::CredentialList]
       def credentials(sid=:unset)
@@ -42,7 +45,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
       # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Chat::V2::ServiceList]
       def services(sid=:unset)

data/lib/twilio-ruby/rest/client.rb

@@ -3,43 +3,63 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     ##
     # A client for accessing the Twilio API.
     class Client
-      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region
+      @@default_region = 'us1'
+
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge, :logger
 
       ##
       # Initializes the Twilio Client
-      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=Twilio::HTTP::Client.new)
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=nil, logger=nil)
         @username = username || Twilio.account_sid
         @password = password || Twilio.auth_token
-        @region = region
+        @region = region || Twilio.region
+        @edge = Twilio.edge
         @account_sid = account_sid || @username
         @auth_token = @password
         @auth = [@username, @password]
-        @http_client = http_client
+        @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+        @logger = logger || Twilio.logger
 
         # Domains
         @accounts = nil
         @api = nil
+        @autopilot = nil
         @chat = nil
+        @conversations = nil
+        @events = nil
         @fax = nil
+        @flex_api = nil
+        @frontline_api = nil
+        @insights = nil
         @ip_messaging = nil
         @lookups = nil
+        @messaging = nil
         @monitor = nil
         @notify = nil
+        @numbers = nil
         @preview = nil
         @pricing = nil
         @proxy = nil
+        @serverless = nil
+        @studio = nil
+        @sync = nil
         @taskrouter = nil
         @trunking = nil
+        @trusthub = nil
+        @verify = nil
         @video = nil
-        @messaging = nil
+        @voice = nil
         @wireless = nil
-        @sync = nil
+        @supersim = nil
+        @bulkexports = nil
       end
 
       ##
@@ -61,14 +81,26 @@ module Twilio
           headers['Accept'] = 'application/json'
         end
 
-        if !region.nil?
-            head, tail  = uri.split('.', 2)
-            if !tail.start_with?(region)
-                uri = [head, region, tail].join('.')
+        uri = build_uri(uri)
+
+        if @logger
+          @logger.debug("--BEGIN Twilio API Request--")
+          @logger.debug("Request Method: <#{method}>")
+
+          headers.each do |key, value|
+            unless key.downcase == 'authorization'
+              @logger.debug("#{key}:#{value}")
             end
+          end
+
+          url = URI(uri)
+          @logger.debug("Host:#{url.host}")
+          @logger.debug("Path:#{url.path}")
+          @logger.debug("Query:#{url.query}")
+          @logger.debug("Request Params:#{params}")
         end
 
-        @http_client.request(
+        response = @http_client.request(
           host,
           port,
           method,
@@ -79,6 +111,52 @@ module Twilio
           auth,
           timeout
         )
+
+        if @logger
+          @logger.debug("Response Status Code:#{response.status_code}")
+          @logger.debug("Response Headers:#{response.headers}")
+          @logger.debug("--END TWILIO API REQUEST--")
+        end
+
+        response
+      end
+
+      ##
+      # Build the final request uri
+      def build_uri(uri)
+        if @region.nil? and @edge.nil?
+          return uri
+        end
+
+        parsed_url = URI(uri)
+        pieces = parsed_url.host.split('.')
+        product = pieces[0]
+        domain = pieces[-2, 2]
+        new_edge = @edge
+        new_region = @region
+
+        if pieces.length == 4
+          new_region ||= pieces[1]
+        elsif pieces.length == 5
+          new_edge ||= pieces[1]
+          new_region ||= pieces[2]
+        end
+
+        if !new_edge.nil? && new_region.nil?
+          new_region = @@default_region
+        end
+
+        parsed_url.host = [product, new_edge, new_region, domain].select {|item| !item.nil?}.join('.')
+        parsed_url.to_s
+      end
+
+      ##
+      # Validate the new SSL certificate for the Twilio API
+      def validate_ssl_certificate
+        response = request('api.twilio.com', '8443', 'GET', 'https://api.twilio.com:8443/.json')
+        if response.status_code < 200 || response.status_code >= 300
+          raise RestError.new 'Unexpected response from certificate endpoint', response
+        end
       end
 
       ##
@@ -93,18 +171,54 @@ module Twilio
         @api ||= Api.new self
       end
 
+      ##
+      # Access the Autopilot Twilio Domain
+      def autopilot
+        @autopilot ||= Autopilot.new self
+      end
+
       ##
       # Access the Chat Twilio Domain
       def chat
         @chat ||= Chat.new self
       end
 
+      ##
+      # Access the Conversations Twilio Domain
+      def conversations
+        @conversations ||= Conversations.new self
+      end
+
+      ##
+      # Access the Events Twilio Domain
+      def events
+        @events ||= Events.new self
+      end
+
       ##
       # Access the Fax Twilio Domain
       def fax
         @fax ||= Fax.new self
       end
 
+      ##
+      # Access the FlexApi Twilio Domain
+      def flex_api
+        @flex_api ||= FlexApi.new self
+      end
+
+      ##
+      # Access the FrontlineApi Twilio Domain
+      def frontline_api
+        @frontline_api ||= FrontlineApi.new self
+      end
+
+      ##
+      # Access the Insights Twilio Domain
+      def insights
+        @insights ||= Insights.new self
+      end
+
       ##
       # Access the IpMessaging Twilio Domain
       def ip_messaging
@@ -117,6 +231,12 @@ module Twilio
         @lookups ||= Lookups.new self
       end
 
+      ##
+      # Access the Messaging Twilio Domain
+      def messaging
+        @messaging ||= Messaging.new self
+      end
+
       ##
       # Access the Monitor Twilio Domain
       def monitor
@@ -129,6 +249,12 @@ module Twilio
         @notify ||= Notify.new self
       end
 
+      ##
+      # Access the Numbers Twilio Domain
+      def numbers
+        @numbers ||= Numbers.new self
+      end
+
       ##
       # Access the Preview Twilio Domain
       def preview
@@ -147,6 +273,24 @@ module Twilio
         @proxy ||= Proxy.new self
       end
 
+      ##
+      # Access the Serverless Twilio Domain
+      def serverless
+        @serverless ||= Serverless.new self
+      end
+
+      ##
+      # Access the Studio Twilio Domain
+      def studio
+        @studio ||= Studio.new self
+      end
+
+      ##
+      # Access the Sync Twilio Domain
+      def sync
+        @sync ||= Sync.new self
+      end
+
       ##
       # Access the Taskrouter Twilio Domain
       def taskrouter
@@ -159,6 +303,18 @@ module Twilio
         @trunking ||= Trunking.new self
       end
 
+      ##
+      # Access the Trusthub Twilio Domain
+      def trusthub
+        @trusthub ||= Trusthub.new self
+      end
+
+      ##
+      # Access the Verify Twilio Domain
+      def verify
+        @verify ||= Verify.new self
+      end
+
       ##
       # Access the Video Twilio Domain
       def video
@@ -166,9 +322,9 @@ module Twilio
       end
 
       ##
-      # Access the Messaging Twilio Domain
-      def messaging
-        @messaging ||= Messaging.new self
+      # Access the Voice Twilio Domain
+      def voice
+        @voice ||= Voice.new self
       end
 
       ##
@@ -178,13 +334,20 @@ module Twilio
       end
 
       ##
-      # Access the Sync Twilio Domain
-      def sync
-        @sync ||= Sync.new self
+      # Access the Supersim Twilio Domain
+      def supersim
+        @supersim ||= Supersim.new self
       end
 
       ##
-      # @param [String] sid The sid
+      # Access the Bulkexports Twilio Domain
+      def bulkexports
+        @bulkexports ||= Bulkexports.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the
+      #   Address resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AddressList]
       def addresses(sid=:unset)
@@ -192,8 +355,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Application resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ApplicationList]
       def applications(sid=:unset)
@@ -201,8 +364,7 @@ module Twilio
       end
 
       ##
-      # @param [String] connect_app_sid The unique id of the Connect App that was
-      #   authorized.
+      # @param [String] connect_app_sid The SID that we assigned to the Connect App.
       # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance] if connect_app_sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList]
       def authorized_connect_apps(connect_app_sid=:unset)
@@ -210,7 +372,9 @@ module Twilio
       end
 
       ##
-      # @param [String] country_code The ISO Country code to lookup phone numbers for.
+      # @param [String] country_code The
+      #   {ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of
+      #   the country.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if country_code was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
       def available_phone_numbers(country_code=:unset)
@@ -218,7 +382,13 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
+      # @return [Twilio::REST::Api::V2010::AccountContext::BalanceInstance]
+      def balance
+        self.api.v2010.account.balance
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify this Call
       #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallList]
@@ -227,8 +397,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   conference.
+      # @param [String] sid The unique string that that we created to identify this
+      #   Conference resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConferenceList]
       def conferences(sid=:unset)
@@ -236,7 +406,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique id of this Connect App.
+      # @param [String] sid The unique string that that we created to identify the
+      #   ConnectApp resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ConnectAppList]
       def connect_apps(sid=:unset)
@@ -244,8 +415,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify this
+      #   IncomingPhoneNumber resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberList]
       def incoming_phone_numbers(sid=:unset)
@@ -253,7 +424,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that that we created to identify the Key
+      #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::KeyList]
       def keys(sid=:unset)
@@ -261,8 +433,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Message resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
@@ -282,8 +454,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Notification resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::NotificationInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::NotificationList]
       def notifications(sid=:unset)
@@ -291,8 +463,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   OutgoingCallerId resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList]
       def outgoing_caller_ids(sid=:unset)
@@ -300,7 +472,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this queue.
+      # @param [String] sid The unique string that that we created to identify this
+      #   Queue resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::QueueInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::QueueList]
       def queues(sid=:unset)
@@ -308,8 +481,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Recording resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::RecordingList]
       def recordings(sid=:unset)
@@ -331,8 +504,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify this
+      #   ShortCode resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::ShortCodeList]
       def short_codes(sid=:unset)
@@ -346,8 +519,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid The unique string that that we created to identify the
+      #   Transcription resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)