twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -11,43 +11,60 @@ module Twilio
     ##
     # 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, :user_agent_extensions
 
       ##
       # 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, user_agent_extensions=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
+        @user_agent_extensions = user_agent_extensions || []
 
         # Domains
         @accounts = nil
         @api = nil
-        @authy = nil
         @autopilot = nil
         @chat = nil
-        @fax = nil
+        @content = nil
+        @conversations = nil
+        @events = nil
+        @flex_api = nil
+        @frontline_api = nil
+        @insights = nil
         @ip_messaging = nil
         @lookups = nil
+        @media = nil
+        @messaging = nil
         @monitor = nil
         @notify = nil
+        @numbers = nil
+        @oauth = nil
         @preview = nil
         @pricing = nil
         @proxy = nil
+        @routes = nil
+        @serverless = nil
+        @studio = nil
+        @sync = nil
         @taskrouter = nil
         @trunking = nil
-        @video = nil
-        @messaging = nil
-        @wireless = nil
-        @sync = nil
-        @studio = nil
+        @trusthub = nil
         @verify = nil
+        @video = nil
         @voice = nil
-        @insights = nil
+        @wireless = nil
+        @supersim = nil
+        @bulkexports = nil
+        @microvisor = nil
       end
 
       ##
@@ -56,11 +73,12 @@ module Twilio
       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})"
+        ruby_config = RbConfig::CONFIG
+        headers['User-Agent'] = "twilio-ruby/#{Twilio::VERSION} (#{ruby_config["host_os"]} #{ruby_config["host_cpu"]}) Ruby/#{RUBY_VERSION}"
         headers['Accept-Charset'] = 'utf-8'
 
+        user_agent_extensions.each { |extension| headers['User-Agent'] += " #{extension}" }
+
         if method == 'POST' && !headers['Content-Type']
           headers['Content-Type'] = 'application/x-www-form-urlencoded'
         end
@@ -69,14 +87,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,
@@ -87,6 +117,43 @@ 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
 
       ##
@@ -110,12 +177,6 @@ module Twilio
         @api ||= Api.new self
       end
 
-      ##
-      # Access the Authy Twilio Domain
-      def authy
-        @authy ||= Authy.new self
-      end
-
       ##
       # Access the Autopilot Twilio Domain
       def autopilot
@@ -129,9 +190,39 @@ module Twilio
       end
 
       ##
-      # Access the Fax Twilio Domain
-      def fax
-        @fax ||= Fax.new self
+      # 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
 
       ##
@@ -146,6 +237,18 @@ module Twilio
         @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 Monitor Twilio Domain
       def monitor
@@ -158,6 +261,18 @@ module Twilio
         @notify ||= Notify.new self
       end
 
+      ##
+      # Access the Numbers Twilio Domain
+      def numbers
+        @numbers ||= Numbers.new self
+      end
+
+      ##
+      # Access the Oauth Twilio Domain
+      def oauth
+        @oauth ||= Oauth.new self
+      end
+
       ##
       # Access the Preview Twilio Domain
       def preview
@@ -177,45 +292,45 @@ module Twilio
       end
 
       ##
-      # Access the Taskrouter Twilio Domain
-      def taskrouter
-        @taskrouter ||= Taskrouter.new self
+      # Access the Routes Twilio Domain
+      def routes
+        @routes ||= Routes.new self
       end
 
       ##
-      # Access the Trunking Twilio Domain
-      def trunking
-        @trunking ||= Trunking.new self
+      # Access the Serverless Twilio Domain
+      def serverless
+        @serverless ||= Serverless.new self
       end
 
       ##
-      # Access the Video Twilio Domain
-      def video
-        @video ||= Video.new self
+      # Access the Studio Twilio Domain
+      def studio
+        @studio ||= Studio.new self
       end
 
       ##
-      # Access the Messaging Twilio Domain
-      def messaging
-        @messaging ||= Messaging.new self
+      # Access the Sync Twilio Domain
+      def sync
+        @sync ||= Sync.new self
       end
 
       ##
-      # Access the Wireless Twilio Domain
-      def wireless
-        @wireless ||= Wireless.new self
+      # Access the Taskrouter Twilio Domain
+      def taskrouter
+        @taskrouter ||= Taskrouter.new self
       end
 
       ##
-      # Access the Sync Twilio Domain
-      def sync
-        @sync ||= Sync.new self
+      # Access the Trunking Twilio Domain
+      def trunking
+        @trunking ||= Trunking.new self
       end
 
       ##
-      # Access the Studio Twilio Domain
-      def studio
-        @studio ||= Studio.new self
+      # Access the Trusthub Twilio Domain
+      def trusthub
+        @trusthub ||= Trusthub.new self
       end
 
       ##
@@ -224,6 +339,12 @@ module Twilio
         @verify ||= Verify.new self
       end
 
+      ##
+      # Access the Video Twilio Domain
+      def video
+        @video ||= Video.new self
+      end
+
       ##
       # Access the Voice Twilio Domain
       def voice
@@ -231,13 +352,32 @@ module Twilio
       end
 
       ##
-      # Access the Insights Twilio Domain
-      def insights
-        @insights ||= Insights.new self
+      # Access the Wireless Twilio Domain
+      def wireless
+        @wireless ||= Wireless.new self
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this address.
+      # Access the Supersim Twilio Domain
+      def supersim
+        @supersim ||= Supersim.new self
+      end
+
+      ##
+      # Access the Bulkexports Twilio Domain
+      def bulkexports
+        @bulkexports ||= Bulkexports.new self
+      end
+
+      ##
+      # Access the Microvisor Twilio Domain
+      def microvisor
+        @microvisor ||= Microvisor.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)
@@ -245,8 +385,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)
@@ -254,8 +394,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)
@@ -263,7 +402,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)
@@ -277,7 +418,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that that we created to identify this Call
+      # @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]
@@ -295,7 +436,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)
@@ -303,8 +445,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)
@@ -312,8 +454,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this API Key.
-      #    You will use this as the basic-auth `user` when authenticating to the API.
+      # @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)
@@ -321,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
+      #   Message resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::MessageList]
       def messages(sid=:unset)
@@ -342,8 +484,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)
@@ -351,8 +493,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)
@@ -369,8 +511,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)
@@ -407,7 +549,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A unique 34-character string that 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)

data/lib/twilio-ruby/rest/content/v1/content/approval_fetch.rb

@@ -0,0 +1,195 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Content < Domain
+      class V1 < Version
+        class ContentContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ApprovalFetchList < ListResource
+            ##
+            # Initialize the ApprovalFetchList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The unique string that that we created to identify the
+            #   Content resource.
+            # @return [ApprovalFetchList] ApprovalFetchList
+            def initialize(version, sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Content.V1.ApprovalFetchList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ApprovalFetchPage < Page
+            ##
+            # Initialize the ApprovalFetchPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [ApprovalFetchPage] ApprovalFetchPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of ApprovalFetchInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [ApprovalFetchInstance] ApprovalFetchInstance
+            def get_instance(payload)
+              ApprovalFetchInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Content.V1.ApprovalFetchPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ApprovalFetchContext < InstanceContext
+            ##
+            # Initialize the ApprovalFetchContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Content resource whose approval information to fetch.
+            # @return [ApprovalFetchContext] ApprovalFetchContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/Content/#{@solution[:sid]}/ApprovalRequests"
+            end
+
+            ##
+            # Fetch the ApprovalFetchInstance
+            # @return [ApprovalFetchInstance] Fetched ApprovalFetchInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              ApprovalFetchInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Content.V1.ApprovalFetchContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Content.V1.ApprovalFetchContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class ApprovalFetchInstance < InstanceResource
+            ##
+            # Initialize the ApprovalFetchInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The unique string that that we created to identify the
+            #   Content resource.
+            # @return [ApprovalFetchInstance] ApprovalFetchInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'whatsapp' => payload['whatsapp'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'sid' => sid, }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [ApprovalFetchContext] ApprovalFetchContext for this ApprovalFetchInstance
+            def context
+              unless @instance_context
+                @instance_context = ApprovalFetchContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the Content resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the Content resource
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [Hash] Contains the whatsapp approval information for the Content resource
+            def whatsapp
+              @properties['whatsapp']
+            end
+
+            ##
+            # @return [String] The URL of the resource, relative to `https://content.twilio.com`
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the ApprovalFetchInstance
+            # @return [ApprovalFetchInstance] Fetched ApprovalFetchInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Content.V1.ApprovalFetchInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Content.V1.ApprovalFetchInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end