twilio-ruby 3.11.5 → 5.71.0

data/lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb

@@ -0,0 +1,277 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < Version
+        ##
+        # 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 CurrentCallList < ListResource
+          ##
+          # Initialize the CurrentCallList
+          # @param [Version] version Version that contains the resource
+          # @return [CurrentCallList] CurrentCallList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.CurrentCallList>'
+          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 CurrentCallPage < Page
+          ##
+          # Initialize the CurrentCallPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CurrentCallPage] CurrentCallPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CurrentCallInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CurrentCallInstance] CurrentCallInstance
+          def get_instance(payload)
+            CurrentCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.CurrentCallPage>'
+          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 CurrentCallContext < InstanceContext
+          ##
+          # Initialize the CurrentCallContext
+          # @param [Version] version Version that contains the resource
+          # @return [CurrentCallContext] CurrentCallContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/CurrentCall"
+          end
+
+          ##
+          # Fetch the CurrentCallInstance
+          # @param [String] x_xcnam_sensitive_phone_number_from The originating Phone
+          #   Number, given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
+          #   This phone number should be a Twilio number, otherwise it will return an error
+          #   with HTTP Status Code 400.
+          # @param [String] x_xcnam_sensitive_phone_number_to The terminating Phone Number,
+          #   given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
+          # @return [CurrentCallInstance] Fetched CurrentCallInstance
+          def fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset)
+            headers = Twilio::Values.of({
+                'X-Xcnam-Sensitive-Phone-Number-From' => x_xcnam_sensitive_phone_number_from,
+                'X-Xcnam-Sensitive-Phone-Number-To' => x_xcnam_sensitive_phone_number_to,
+            })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            CurrentCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CurrentCallContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CurrentCallContext #{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 CurrentCallInstance < InstanceResource
+          ##
+          # Initialize the CurrentCallInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [CurrentCallInstance] CurrentCallInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'bg_color' => payload['bg_color'],
+                'caller' => payload['caller'],
+                'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                'font_color' => payload['font_color'],
+                'from' => payload['from'],
+                'logo' => payload['logo'],
+                'manager' => payload['manager'],
+                'reason' => payload['reason'],
+                'shield_img' => payload['shield_img'],
+                'sid' => payload['sid'],
+                'status' => payload['status'],
+                'to' => payload['to'],
+                'url' => payload['url'],
+                'use_case' => payload['use_case'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [CurrentCallContext] CurrentCallContext for this CurrentCallInstance
+          def context
+            unless @instance_context
+              @instance_context = CurrentCallContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Background color of the current phone call
+          def bg_color
+            @properties['bg_color']
+          end
+
+          ##
+          # @return [String] Caller name of the current phone call
+          def caller
+            @properties['caller']
+          end
+
+          ##
+          # @return [Time] The date this current phone call was created
+          def created_at
+            @properties['created_at']
+          end
+
+          ##
+          # @return [String] Font color of the current phone call
+          def font_color
+            @properties['font_color']
+          end
+
+          ##
+          # @return [String] The originating phone number
+          def from
+            @properties['from']
+          end
+
+          ##
+          # @return [String] Logo URL of the caller
+          def logo
+            @properties['logo']
+          end
+
+          ##
+          # @return [String] The name of the CPS organization
+          def manager
+            @properties['manager']
+          end
+
+          ##
+          # @return [String] The business reason for this current phone call
+          def reason
+            @properties['reason']
+          end
+
+          ##
+          # @return [String] Shield image URL that serves as authenticity proof of the current phone call
+          def shield_img
+            @properties['shield_img']
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this current branded phone call.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The status of the current phone call
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [String] The terminating phone number
+          def to
+            @properties['to']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The use case for the current phone call
+          def use_case
+            @properties['use_case']
+          end
+
+          ##
+          # Fetch the CurrentCallInstance
+          # @param [String] x_xcnam_sensitive_phone_number_from The originating Phone
+          #   Number, given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
+          #   This phone number should be a Twilio number, otherwise it will return an error
+          #   with HTTP Status Code 400.
+          # @param [String] x_xcnam_sensitive_phone_number_to The terminating Phone Number,
+          #   given in {E.164 format}[https://www.twilio.com/docs/glossary/what-e164].
+          # @return [CurrentCallInstance] Fetched CurrentCallInstance
+          def fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset)
+            context.fetch(
+                x_xcnam_sensitive_phone_number_from: x_xcnam_sensitive_phone_number_from,
+                x_xcnam_sensitive_phone_number_to: x_xcnam_sensitive_phone_number_to,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CurrentCallInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CurrentCallInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/trusted_comms.rb

@@ -0,0 +1,65 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview
+      class TrustedComms < Version
+        ##
+        # Initialize the TrustedComms version of Preview
+        def initialize(domain)
+          super
+          @version = 'TrustedComms'
+          @branded_channels = nil
+          @brands_information = nil
+          @cps = nil
+          @current_calls = nil
+        end
+
+        ##
+        # @param [String] sid The unique SID identifier of the Branded Channel.
+        # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelContext] if sid was passed.
+        # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelList]
+        def branded_channels(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @branded_channels ||= BrandedChannelList.new self
+          else
+              BrandedChannelContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationContext]
+        def brands_information
+          @brands_information ||= BrandsInformationContext.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::CpsContext]
+        def cps
+          @cps ||= CpsContext.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::CurrentCallContext]
+        def current_calls
+          @current_calls ||= CurrentCallContext.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Preview::TrustedComms>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/understand/assistant/assistant_fallback_actions.rb

@@ -0,0 +1,212 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Understand < Version
+        class AssistantContext < 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 AssistantFallbackActionsList < ListResource
+            ##
+            # Initialize the AssistantFallbackActionsList
+            # @param [Version] version Version that contains the resource
+            # @param [String] assistant_sid The assistant_sid
+            # @return [AssistantFallbackActionsList] AssistantFallbackActionsList
+            def initialize(version, assistant_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {assistant_sid: assistant_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.Understand.AssistantFallbackActionsList>'
+            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 AssistantFallbackActionsPage < Page
+            ##
+            # Initialize the AssistantFallbackActionsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AssistantFallbackActionsPage] AssistantFallbackActionsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AssistantFallbackActionsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AssistantFallbackActionsInstance] AssistantFallbackActionsInstance
+            def get_instance(payload)
+              AssistantFallbackActionsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.Understand.AssistantFallbackActionsPage>'
+            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 AssistantFallbackActionsContext < InstanceContext
+            ##
+            # Initialize the AssistantFallbackActionsContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] assistant_sid The assistant_sid
+            # @return [AssistantFallbackActionsContext] AssistantFallbackActionsContext
+            def initialize(version, assistant_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {assistant_sid: assistant_sid, }
+              @uri = "/Assistants/#{@solution[:assistant_sid]}/FallbackActions"
+            end
+
+            ##
+            # Fetch the AssistantFallbackActionsInstance
+            # @return [AssistantFallbackActionsInstance] Fetched AssistantFallbackActionsInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AssistantFallbackActionsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
+            end
+
+            ##
+            # Update the AssistantFallbackActionsInstance
+            # @param [Hash] fallback_actions The fallback_actions
+            # @return [AssistantFallbackActionsInstance] Updated AssistantFallbackActionsInstance
+            def update(fallback_actions: :unset)
+              data = Twilio::Values.of({'FallbackActions' => Twilio.serialize_object(fallback_actions), })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              AssistantFallbackActionsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Understand.AssistantFallbackActionsContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Understand.AssistantFallbackActionsContext #{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 AssistantFallbackActionsInstance < InstanceResource
+            ##
+            # Initialize the AssistantFallbackActionsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] assistant_sid The assistant_sid
+            # @return [AssistantFallbackActionsInstance] AssistantFallbackActionsInstance
+            def initialize(version, payload, assistant_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'assistant_sid' => payload['assistant_sid'],
+                  'url' => payload['url'],
+                  'data' => payload['data'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'assistant_sid' => assistant_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 [AssistantFallbackActionsContext] AssistantFallbackActionsContext for this AssistantFallbackActionsInstance
+            def context
+              unless @instance_context
+                @instance_context = AssistantFallbackActionsContext.new(@version, @params['assistant_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The assistant_sid
+            def assistant_sid
+              @properties['assistant_sid']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [Hash] The data
+            def data
+              @properties['data']
+            end
+
+            ##
+            # Fetch the AssistantFallbackActionsInstance
+            # @return [AssistantFallbackActionsInstance] Fetched AssistantFallbackActionsInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the AssistantFallbackActionsInstance
+            # @param [Hash] fallback_actions The fallback_actions
+            # @return [AssistantFallbackActionsInstance] Updated AssistantFallbackActionsInstance
+            def update(fallback_actions: :unset)
+              context.update(fallback_actions: fallback_actions, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Understand.AssistantFallbackActionsInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Understand.AssistantFallbackActionsInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end