twilio-ruby 4.13.0 → 5.40.0

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

@@ -1,170 +1,537 @@
-require 'twilio-ruby/rest/base_client'
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
     ##
-    # The Twilio::REST::Client class caches authentication parameters and
-    # exposes methods to make HTTP requests to Twilio's REST API. However, you
-    # should never really need to call these methods yourself since you can
-    # work with the more pleasant wrapper objects like Twilio::REST::Call.
-    #
-    # Instantiate a client like so:
-    #
-    #   @client = Twilio::REST::Client.new account_sid, auth_token
-    #
-    # There are a few options you can use to configure the way your client will
-    # communicate with Twilio. See #new for a list and descriptions.
-    #
-    # Once you have a client object you can use it to do fun things. Every
-    # client object exposes two wrapper objects which you can use as entry
-    # points into Twilio: +account+ and +accounts+.
-    #
-    # ==== @client.account
-    #
-    # Most of the time you'll want to start with the +account+ attribute. This
-    # object is an instance of Twilio::REST::Account that wraps the account
-    # referenced by the +account_sid+ you used when instantiating the client.
-    #
-    # An instance of Twilio::REST::Account exposes objects wrapping all of the
-    # account-level Twilio resources as properties. So
-    #
-    #   @client.account.calls
-    #
-    # For convenience, the resources of the default account are also available
-    # on the client object. So the following call is equivalent to the example
-    # above
-    #
-    #   @client.calls
-    #
-    # represents an account's call list.
-    #
-    # ==== @client.accounts
-    #
-    # If you are doing anything related to subaccounts you'll want to start
-    # here. This object is an instance of Twilio::REST::Accounts that wraps
-    # the list of accounts belonging to the master account referenced by
-    # the +account_sid+ used to instantiate the client.
-    #
-    # This class inherits from Twilio::REST::ListResource, so you can use
-    # methods like ListResource#list to return a (possibly filtered) list of
-    # accounts and ListResource#create to create a new account. Use
-    # ListResource#get to grab a particular account once you know its sid.
-    class Client < BaseClient
-      API_VERSION = '2010-04-01'
-      attr_reader :account, :accounts
-
-      host 'api.twilio.com'
-
-      ##
-      # Instantiate a new HTTP client to talk to Twilio. The parameters
-      # +account_sid+ and +auth_token+ are required, unless you have configured
-      # them already using the block configure syntax, and used to generate the
-      # HTTP basic auth header in each request. The +options+ parameter is a
-      # hash of connection configuration options. the following keys are
-      # supported:
-      #
-      # === <tt>host: 'api.twilio.com'</tt>
-      #
-      # The domain to which you'd like the client to make HTTP requests. Useful
-      # for testing. Defaults to 'api.twilio.com'.
-      #
-      # === <tt>port: 443</tt>
-      #
-      # The port on which to connect to the above domain. Defaults to 443 and
-      # should be left that way except in testing environments.
-      #
-      # === <tt>use_ssl: true</tt>
-      #
-      # Declare whether ssl should be used for connections to the above domain.
-      # Defaults to true and should be left alone except when testing.
-      #
-      # === <tt>ssl_verify_peer: true</tt>
-      #
-      # Declare whether to verify the host's ssl cert when setting up the
-      # connection to the above domain. Defaults to true, but can be turned off
-      # to avoid ssl certificate verification failures in environments without
-      # the necessary ca certificates.
-      #
-      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
-      #
-      # Specify the path to the certificate authority bundle you'd like to use
-      # to verify Twilio's SSL certificate on each request. If not specified, a
-      # certificate bundle extraced from Firefox is packaged with the gem and
-      # used by default.
-      #
-      # === <tt>timeout: 30</tt>
-      #
-      # Set the time in seconds to wait before timing out the HTTP request.
-      # Defaults to 30 seconds. If you aren't fetching giant pages of call or
-      # SMS logs you can safely decrease this to something like 3 seconds or
-      # lower. In paricular if you are sending SMS you can set this to 1 second
-      # or less and swallow the exception if you don't care about the response.
-      #
-      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
-      #
-      # The domain of a proxy through which you'd like the client to make HTTP
-      # requests. Defaults to nil.
-      #
-      # === <tt>proxy_port: 3128</tt>
-      #
-      # The port on which to connect to the above proxy. Defaults to nil.
-      #
-      # === <tt>proxy_user: 'username'</tt>
-      #
-      # The user name to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>proxy_pass: 'password'</tt>
-      #
-      # The password to use for authentication with the proxy. Defaults to nil.
-      #
-      # === <tt>retry_limit: 1</tt>
-      #
-      # The number of times to retry a request that has failed before throwing
-      # an exception. Defaults to one.
-      def initialize(*args)
-        super(*args)
-      end
-
-      def inspect # :nodoc:
-        "<Twilio::REST::Client @account_sid=#{@account_sid}>"
-      end
-
-      ##
-      # Delegate account methods from the client. This saves having to call
-      # <tt>client.account</tt> every time for resources on the default
-      # account.
-      def method_missing(method_name, *args, &block)
-        if account.respond_to?(method_name)
-          account.send(method_name, *args, &block)
-        else
-          super
+    # A client for accessing the Twilio API.
+    class Client
+      @@default_region = 'us1'
+
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge
+
+      ##
+      # Initializes the Twilio Client
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=nil)
+        @username = username || Twilio.account_sid
+        @password = password || Twilio.auth_token
+        @region = region || Twilio.region
+        @edge = Twilio.edge
+        @account_sid = account_sid || @username
+        @auth_token = @password
+        @auth = [@username, @password]
+        @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+
+        # Domains
+        @accounts = nil
+        @api = nil
+        @autopilot = nil
+        @chat = nil
+        @conversations = nil
+        @events = nil
+        @fax = nil
+        @flex_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
+        @verify = nil
+        @video = nil
+        @voice = nil
+        @wireless = nil
+        @supersim = nil
+        @bulkexports = nil
+      end
+
+      ##
+      # Makes a request to the Twilio API using the configured http client
+      # Authentication information is automatically added if none is provided
+      def request(host, port, method, uri, params={}, data={}, headers={}, auth=nil, timeout=nil)
+        auth ||= @auth
+
+        headers['User-Agent'] = "twilio-ruby/#{Twilio::VERSION}" +
+                                " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" +
+                                " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+        headers['Accept-Charset'] = 'utf-8'
+
+        if method == 'POST' && !headers['Content-Type']
+          headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        end
+
+        unless headers['Accept']
+          headers['Accept'] = 'application/json'
         end
+
+        uri = build_uri(uri)
+
+        @http_client.request(
+          host,
+          port,
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
       end
 
-      def respond_to?(method_name, include_private=false)
-        if account.respond_to?(method_name, include_private)
-          true
-        else
-          super
+      ##
+      # 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
 
-      protected
+      ##
+      # 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
 
       ##
-      # Set up +account+ and +accounts+ attributes.
-      def set_up_subresources # :doc:
-        @accounts = Twilio::REST::Accounts.new "/#{API_VERSION}/Accounts", self
-        @account = @accounts.get @account_sid
+      # Access the Accounts Twilio Domain
+      def accounts
+        @accounts ||= Accounts.new self
       end
 
       ##
-      # Builds up full request path
-      def build_full_path(path, params, method)
-        path = "#{path}.json"
-        path << "?#{url_encode(params)}" if method == :get && !params.empty?
-        path
+      # Access the Api Twilio Domain
+      def api
+        @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 Insights Twilio Domain
+      def insights
+        @insights ||= Insights.new self
+      end
+
+      ##
+      # Access the IpMessaging Twilio Domain
+      def ip_messaging
+        @ip_messaging ||= IpMessaging.new self
+      end
+
+      ##
+      # Access the Lookups Twilio Domain
+      def lookups
+        @lookups ||= Lookups.new self
+      end
+
+      ##
+      # Access the Messaging Twilio Domain
+      def messaging
+        @messaging ||= Messaging.new self
+      end
+
+      ##
+      # Access the Monitor Twilio Domain
+      def monitor
+        @monitor ||= Monitor.new self
+      end
+
+      ##
+      # Access the Notify Twilio Domain
+      def notify
+        @notify ||= Notify.new self
+      end
+
+      ##
+      # Access the Numbers Twilio Domain
+      def numbers
+        @numbers ||= Numbers.new self
+      end
+
+      ##
+      # Access the Preview Twilio Domain
+      def preview
+        @preview ||= Preview.new self
+      end
+
+      ##
+      # Access the Pricing Twilio Domain
+      def pricing
+        @pricing ||= Pricing.new self
+      end
+
+      ##
+      # Access the Proxy Twilio Domain
+      def proxy
+        @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
+        @taskrouter ||= Taskrouter.new self
+      end
+
+      ##
+      # Access the Trunking Twilio Domain
+      def trunking
+        @trunking ||= Trunking.new self
+      end
+
+      ##
+      # Access the Verify Twilio Domain
+      def verify
+        @verify ||= Verify.new self
+      end
+
+      ##
+      # Access the Video Twilio Domain
+      def video
+        @video ||= Video.new self
+      end
+
+      ##
+      # Access the Voice Twilio Domain
+      def voice
+        @voice ||= Voice.new self
+      end
+
+      ##
+      # Access the Wireless Twilio Domain
+      def wireless
+        @wireless ||= Wireless.new self
+      end
+
+      ##
+      # Access the Supersim Twilio Domain
+      def supersim
+        @supersim ||= Supersim.new self
+      end
+
+      ##
+      # 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)
+        self.api.v2010.account.addresses(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.applications(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.authorized_connect_apps(connect_app_sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.available_phone_numbers(country_code)
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::BalanceInstance]
+      def balance
+        self.api.v2010.account.balance
+      end
+
+      ##
+      # @param [String] sid The unique string that 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]
+      def calls(sid=:unset)
+        self.api.v2010.account.calls(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.conferences(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.connect_apps(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.incoming_phone_numbers(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.keys(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.messages(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewKeyInstance]
+      def new_keys
+        self.api.v2010.account.new_keys
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::NewSigningKeyInstance]
+      def new_signing_keys
+        self.api.v2010.account.new_signing_keys
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.notifications(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.outgoing_caller_ids(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.queues(sid)
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.recordings(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Api::V2010::AccountContext::SigningKeyInstance] if sid was passed.
+      # @return [Twilio::REST::Api::V2010::AccountContext::SigningKeyList]
+      def signing_keys(sid=:unset)
+        self.api.v2010.account.signing_keys(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::SipInstance]
+      def sip
+        self.api.v2010.account.sip
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.short_codes(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::TokenInstance]
+      def tokens
+        self.api.v2010.account.tokens
+      end
+
+      ##
+      # @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)
+        self.api.v2010.account.transcriptions(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::UsageInstance]
+      def usage
+        self.api.v2010.account.usage
+      end
+
+      ##
+      # @return [Twilio::REST::Api::V2010::AccountContext::ValidationRequestInstance]
+      def validation_requests
+        self.api.v2010.account.validation_requests
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        "#<Twilio::REST::Client #{@account_sid}>"
       end
     end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class BaseClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class IpMessagingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class LookupsClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class MonitorClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class PricingClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class TaskRouterClient < ObsoleteClient; end
+
+    ##
+    # Dummy client which provides no functionality. Please use Twilio::REST::Client instead.
+    class TrunkingClient < ObsoleteClient; end
   end
-end
+end