twilio-ruby 4.6.1 → 6.9.0

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

@@ -1,170 +1,346 @@
-require 'twilio-ruby/rest/base_client'
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+
+require 'twilio-ruby/base/client_base'
 
 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
-        end
-      end
+    module REST
+        ##
+        # A client for accessing the Twilio API.
+        class Client < ClientBase
+
+            ##
+            # Access the Accounts Twilio Domain
+            def accounts
+                @accounts ||= Accounts.new self
+            end
+            ##
+            # 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 Bulkexports Twilio Domain
+            def bulkexports
+                @bulkexports ||= Bulkexports.new self
+            end
+            ##
+            # Access the Chat Twilio Domain
+            def chat
+                @chat ||= Chat.new self
+            end
+            ##
+            # Access the Content Twilio Domain
+            def content
+                @content ||= Content.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 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 Intelligence Twilio Domain
+            def intelligence
+                @intelligence ||= Intelligence.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 Media Twilio Domain
+            def media
+                @media ||= Media.new self
+            end
+            ##
+            # Access the Messaging Twilio Domain
+            def messaging
+                @messaging ||= Messaging.new self
+            end
+            ##
+            # Access the Microvisor Twilio Domain
+            def microvisor
+                @microvisor ||= Microvisor.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 Routes Twilio Domain
+            def routes
+                @routes ||= Routes.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 Supersim Twilio Domain
+            def supersim
+                @supersim ||= Supersim.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 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
+                @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
+
+            ##
+            # @param [string] sid The Twilio-provided string that uniquely identifies the Address resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the Application resource to fetch.
+
+            # @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] connectAppSid The SID of the Connect App to fetch.
+
+            # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance] if connectAppSid was passed.
+            # @return [Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppList]
+            def authorized_connect_apps(connectAppSid=:unset)
+                self.api.v2010.account.authorized_connect_apps(connectAppSid)
+            end
+            ##
+            # @param [string] countryCode The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country to fetch available phone number information about.
+
+            # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryInstance] if countryCode was passed.
+            # @return [Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryList]
+            def available_phone_numbers(countryCode=:unset)
+                self.api.v2010.account.available_phone_numbers(countryCode)
+            end
+            
+            ##
+            # @param [string] sid The SID of the Call resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the Conference resource to fetch
+
+            # @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 Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.
 
-      def respond_to?(method_name, include_private=false)
-        if account.respond_to?(method_name, include_private)
-          true
-        else
-          super
+            # @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 Twilio-provided string that uniquely identifies the Key resource to fetch.
+
+            # @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 SID of the Message resource to be fetched
+
+            # @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
+            
+            
+            ##
+            # @param [string] sid The Twilio-provided string that uniquely identifies the Notification resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the Queue resource to fetch
+
+            # @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 Twilio-provided string that uniquely identifies the Recording resource to fetch.
+
+            # @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 Twilio-provided string that uniquely identifies the ShortCode resource to fetch
+
+            # @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::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
+            
+            
+            ##
+            # @param [string] sid The Twilio-provided string that uniquely identifies the Transcription resource to fetch.
+
+            # @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
+            
+            
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+                "#<Twilio::REST::Client #{@account_sid}>"
+            end
         end
-      end
-
-      protected
-
-      ##
-      # 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
-      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
-      end
     end
-  end
 end
+