twilio-ruby 3.11.5 → 5.0.0

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

@@ -0,0 +1,56 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Chat
+      class V2 < Version
+        ##
+        # Initialize the V2 version of Chat
+        def initialize(domain)
+          super
+          @version = 'v2'
+          @credentials = nil
+          @services = nil
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V2::CredentialInstance] 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
+          else
+            CredentialContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The sid
+        # @return [Twilio::REST::Chat::V2::ServiceInstance] 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
+          else
+            ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Chat::V2>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Chat < Domain
+      ##
+      # Initialize the Chat Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://chat.twilio.com'
+        @host = 'chat.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+        @v2 = nil
+      end
+
+      ##
+      # Version v1 of chat
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # Version v2 of chat
+      def v2
+        @v2 ||= V2.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V2::CredentialList]
+      def credentials(sid=:unset)
+        self.v2.credentials(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V2::ServiceList]
+      def services(sid=:unset)
+        self.v2.services(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Chat>'
+      end
+    end
+  end
+end

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

@@ -1,235 +1,327 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
 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
-    #
-    # 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.
+    # A client for accessing the Twilio API.
     class Client
-      include Twilio::Util
-      include Twilio::REST::Utils
-
-      API_VERSION = '2010-04-01'
-
-      # 1.8.7 doesn't have the RUBY_ENGINE constant.
-      engine = !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
-
-      HTTP_HEADERS = {
-        'Accept' => 'application/json',
-        'Accept-Charset' => 'utf-8',
-        'User-Agent' => "twilio-ruby/#{Twilio::VERSION} (#{engine}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})",
-      }
-
-      DEFAULTS = {
-        :host => 'api.twilio.com',
-        :port => 443,
-        :use_ssl => true,
-        :ssl_verify_peer => true,
-        :ssl_ca_file => File.dirname(__FILE__) + '/../../../conf/cacert.pem',
-        :timeout => 30,
-        :proxy_addr => nil,
-        :proxy_port => nil,
-        :proxy_user => nil,
-        :proxy_pass => nil,
-        :retry_limit => 1,
-      }
-
-      attr_reader :account_sid, :account, :accounts, :last_request,
-        :last_response
-
-      ##
-      # Instantiate a new HTTP client to talk to Twilio. The parameters
-      # +account_sid+ and +auth_token+ are required 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(account_sid, auth_token, options={})
-        @account_sid, @auth_token = account_sid.strip, auth_token.strip
-        @config = DEFAULTS.merge! options
-        set_up_connection
-        set_up_subresources
-      end
-
-      def inspect # :nodoc:
-        "<Twilio::REST::Client @account_sid=#{@account_sid}>"
-      end
-
-      ##
-      # Define #get, #put, #post and #delete helper methods for sending HTTP
-      # requests to Twilio. You shouldn't need to use these methods directly,
-      # but they can be useful for debugging. Each method returns a hash
-      # obtained from parsing the JSON object in the response body.
-      [:get, :put, :post, :delete].each do |method|
-        method_class = Net::HTTP.const_get method.to_s.capitalize
-        define_method method do |path, *args|
-          params = twilify args[0]; params = {} if params.empty?
-          unless args[1] # build the full path unless already given
-            path = "#{path}.json"
-            path << "?#{url_encode(params)}" if method == :get && !params.empty?
-          end
-          request = method_class.new path, HTTP_HEADERS
-          request.basic_auth @account_sid, @auth_token
-          request.form_data = params if [:post, :put].include? method
-          connect_and_send request
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region
+
+      ##
+      # Initializes the Twilio Client
+      def initialize(username=nil, password=nil, account_sid=nil, region=nil, http_client=Twilio::HTTP::Client.new)
+        @username = username || Twilio.account_sid
+        @password = password || Twilio.auth_token
+        @region = region
+        @account_sid = account_sid || @username
+        @auth_token = @password
+        @auth = [@username, @password]
+        @http_client = http_client
+
+        # Domains
+        @accounts = nil
+        @api = nil
+        @chat = nil
+        @ip_messaging = nil
+        @lookups = nil
+        @monitor = nil
+        @pricing = nil
+        @taskrouter = nil
+        @trunking = nil
+        @video = 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
+
+        if !region.nil?
+            head, tail  = uri.split('.', 2)
+            if !tail.start_with?(region)
+                uri = [head, region, tail].join('.')
+            end
+        end
+
+        @http_client.request(
+          host,
+          port,
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
       end
 
-      private
+      ##
+      # Access the Accounts Twilio Domain
+      def accounts
+        @accounts ||= Accounts.new self
+      end
 
       ##
-      # Set up and cache a Net::HTTP object to use when making requests. This is
-      # a private method documented for completeness.
-      def set_up_connection # :doc:
-        connection_class = Net::HTTP::Proxy @config[:proxy_addr],
-          @config[:proxy_port], @config[:proxy_user], @config[:proxy_pass]
-        @connection = connection_class.new @config[:host], @config[:port]
-        set_up_ssl
-        @connection.open_timeout = @config[:timeout]
-        @connection.read_timeout = @config[:timeout]
+      # Access the Api Twilio Domain
+      def api
+        @api ||= Api.new self
       end
- 
+
       ##
-      # Set up the ssl properties of the <tt>@connection</tt> Net::HTTP object.
-      # This is a private method documented for completeness.
-      def set_up_ssl # :doc:
-        @connection.use_ssl = @config[:use_ssl]
-        if @config[:ssl_verify_peer]
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          @connection.ca_file = @config[:ssl_ca_file]
-        else
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
+      # Access the Chat Twilio Domain
+      def chat
+        @chat ||= Chat.new self
       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 IpMessaging Twilio Domain
+      def ip_messaging
+        @ip_messaging ||= IpMessaging.new self
       end
 
       ##
-      # Send an HTTP request using the cached <tt>@connection</tt> object and
-      # return the JSON response body parsed into a hash. Also save the raw
-      # Net::HTTP::Request and Net::HTTP::Response objects as
-      # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
-      # inspection later.
-      def connect_and_send(request) # :doc:
-        @last_request = request
-        retries_left = @config[:retry_limit]
-        begin
-          response = @connection.request request
-          @last_response = response
-          if response.kind_of? Net::HTTPServerError
-            raise Twilio::REST::ServerError
-          end
-        rescue Exception
-          raise if request.class == Net::HTTP::Post
-          if retries_left > 0 then retries_left -= 1; retry else raise end
-        end
-        if response.body and !response.body.empty?
-          object = MultiJson.load response.body
-        end
-        if response.kind_of? Net::HTTPClientError
-          raise Twilio::REST::RequestError.new object['message'], object['code']
-        end
-        object
+      # Access the Lookups Twilio Domain
+      def lookups
+        @lookups ||= Lookups.new self
+      end
+
+      ##
+      # Access the Monitor Twilio Domain
+      def monitor
+        @monitor ||= Monitor.new self
+      end
+
+      ##
+      # Access the Pricing Twilio Domain
+      def pricing
+        @pricing ||= Pricing.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 Video Twilio Domain
+      def video
+        @video ||= Video.new self
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @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 A 34 character string that uniquely identifies this
+      #   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 unique id of the Connect App that was
+      #   authorized.
+      # @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 Country code to lookup phone numbers for.
+      # @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
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this
+      #   conference.
+      # @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 id of this Connect App.
+      # @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 A 34 character string that uniquely identifies this
+      #   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 sid
+      # @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 A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this queue.
+      # @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 A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this
+      #   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 A 34 character string that uniquely identifies this
+      #   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
   end
-end
+end