twilio-ruby 5.5.1 → 5.58.3

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

@@ -0,0 +1,195 @@
+##
+# 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 BrandsInformationList < ListResource
+          ##
+          # Initialize the BrandsInformationList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandsInformationList] BrandsInformationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.BrandsInformationList>'
+          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 BrandsInformationPage < Page
+          ##
+          # Initialize the BrandsInformationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandsInformationPage] BrandsInformationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandsInformationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandsInformationInstance] BrandsInformationInstance
+          def get_instance(payload)
+            BrandsInformationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.BrandsInformationPage>'
+          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 BrandsInformationContext < InstanceContext
+          ##
+          # Initialize the BrandsInformationContext
+          # @param [Version] version Version that contains the resource
+          # @return [BrandsInformationContext] BrandsInformationContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/BrandsInformation"
+          end
+
+          ##
+          # Fetch the BrandsInformationInstance
+          # @param [String] if_none_match Standard `If-None-Match` HTTP header. For more
+          #   information visit:
+          #   https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match.
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch(if_none_match: :unset)
+            headers = Twilio::Values.of({'If-None-Match' => if_none_match, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            BrandsInformationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandsInformationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandsInformationContext #{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 BrandsInformationInstance < InstanceResource
+          ##
+          # Initialize the BrandsInformationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [BrandsInformationInstance] BrandsInformationInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'update_time' => Twilio.deserialize_iso8601_datetime(payload['update_time']),
+                'file_link' => payload['file_link'],
+                'file_link_ttl_in_seconds' => payload['file_link_ttl_in_seconds'],
+                'url' => payload['url'],
+            }
+
+            # 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 [BrandsInformationContext] BrandsInformationContext for this BrandsInformationInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandsInformationContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [Time] Creation time of the information retrieved
+          def update_time
+            @properties['update_time']
+          end
+
+          ##
+          # @return [String] The URL to the brands information
+          def file_link
+            @properties['file_link']
+          end
+
+          ##
+          # @return [String] How long will be the `file_link` valid
+          def file_link_ttl_in_seconds
+            @properties['file_link_ttl_in_seconds']
+          end
+
+          ##
+          # @return [String] The URL of this resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the BrandsInformationInstance
+          # @param [String] if_none_match Standard `If-None-Match` HTTP header. For more
+          #   information visit:
+          #   https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match.
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch(if_none_match: :unset)
+            context.fetch(if_none_match: if_none_match, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandsInformationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandsInformationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+##
+# 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 CpsList < ListResource
+          ##
+          # Initialize the CpsList
+          # @param [Version] version Version that contains the resource
+          # @return [CpsList] CpsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.CpsList>'
+          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 CpsPage < Page
+          ##
+          # Initialize the CpsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CpsPage] CpsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CpsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CpsInstance] CpsInstance
+          def get_instance(payload)
+            CpsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.CpsPage>'
+          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 CpsContext < InstanceContext
+          ##
+          # Initialize the CpsContext
+          # @param [Version] version Version that contains the resource
+          # @return [CpsContext] CpsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/CPS"
+          end
+
+          ##
+          # Fetch the CpsInstance
+          # @param [String] x_xcnam_sensitive_phone_number Phone number used to retrieve its
+          #   corresponding CPS.
+          # @return [CpsInstance] Fetched CpsInstance
+          def fetch(x_xcnam_sensitive_phone_number: :unset)
+            headers = Twilio::Values.of({'X-Xcnam-Sensitive-Phone-Number' => x_xcnam_sensitive_phone_number, })
+
+            payload = @version.fetch('GET', @uri, headers: headers)
+
+            CpsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CpsContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CpsContext #{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 CpsInstance < InstanceResource
+          ##
+          # Initialize the CpsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [CpsInstance] CpsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'cps_url' => payload['cps_url'],
+                'phone_number' => payload['phone_number'],
+                'url' => payload['url'],
+            }
+
+            # 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 [CpsContext] CpsContext for this CpsInstance
+          def context
+            unless @instance_context
+              @instance_context = CpsContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] CPS URL of the phone number.
+          def cps_url
+            @properties['cps_url']
+          end
+
+          ##
+          # @return [String] Phone number passed.
+          def phone_number
+            @properties['phone_number']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the CpsInstance
+          # @param [String] x_xcnam_sensitive_phone_number Phone number used to retrieve its
+          #   corresponding CPS.
+          # @return [CpsInstance] Fetched CpsInstance
+          def fetch(x_xcnam_sensitive_phone_number: :unset)
+            context.fetch(x_xcnam_sensitive_phone_number: x_xcnam_sensitive_phone_number, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CpsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CpsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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