twilio-ruby 5.31.1 → 5.54.0

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

@@ -78,16 +78,14 @@ module Twilio
           end
 
           ##
-          # Fetch a CpsInstance
+          # Fetch the CpsInstance
+          # @param [String] x_xcnam_sensitive_phone_number Phone number used to retrieve its
+          #   corresponding CPS.
           # @return [CpsInstance] Fetched CpsInstance
-          def fetch
-            params = Twilio::Values.of({})
+          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,
-                params,
-            )
+            payload = @version.fetch('GET', @uri, headers: headers)
 
             CpsInstance.new(@version, payload, )
           end
@@ -160,10 +158,12 @@ module Twilio
           end
 
           ##
-          # Fetch a CpsInstance
+          # Fetch the CpsInstance
+          # @param [String] x_xcnam_sensitive_phone_number Phone number used to retrieve its
+          #   corresponding CPS.
           # @return [CpsInstance] Fetched CpsInstance
-          def fetch
-            context.fetch
+          def fetch(x_xcnam_sensitive_phone_number: :unset)
+            context.fetch(x_xcnam_sensitive_phone_number: x_xcnam_sensitive_phone_number, )
           end
 
           ##

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

@@ -78,16 +78,21 @@ module Twilio
           end
 
           ##
-          # Fetch a CurrentCallInstance
+          # 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
-            params = Twilio::Values.of({})
+          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,
-                params,
-            )
+            payload = @version.fetch('GET', @uri, headers: headers)
 
             CurrentCallInstance.new(@version, payload, )
           end
@@ -237,10 +242,19 @@ module Twilio
           end
 
           ##
-          # Fetch a CurrentCallInstance
+          # 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
-            context.fetch
+          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
 
           ##

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Preview::Understand::AssistantList]
         def assistants(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @assistants ||= AssistantList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @assistants ||= AssistantList.new self
           else
-            AssistantContext.new(self, sid)
+              AssistantContext.new(self, sid)
           end
         end
 

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

@@ -86,11 +86,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             AssistantPage.new(@version, response, @solution)
           end
 
@@ -108,8 +106,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of AssistantInstance records from the API.
-          # Request is executed immediately.
+          # Create the AssistantInstance
           # @param [String] friendly_name A text description for the Assistant. It is
           #   non-unique and can up to 255 characters long.
           # @param [Boolean] log_queries A boolean that specifies whether queries should be
@@ -127,7 +124,7 @@ module Twilio
           #   phone calls when the Assistant has to say something first.
           # @param [Hash] style_sheet The JSON object that holds the style sheet for the
           #   assistant
-          # @return [AssistantInstance] Newly created AssistantInstance
+          # @return [AssistantInstance] Created AssistantInstance
           def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset, style_sheet: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -140,11 +137,7 @@ module Twilio
                 'StyleSheet' => Twilio.serialize_object(style_sheet),
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             AssistantInstance.new(@version, payload, )
           end
@@ -215,16 +208,10 @@ module Twilio
           end
 
           ##
-          # Fetch a AssistantInstance
+          # Fetch the AssistantInstance
           # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -261,20 +248,16 @@ module Twilio
                 'StyleSheet' => Twilio.serialize_object(style_sheet),
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             AssistantInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the AssistantInstance
+          # Delete the AssistantInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -524,7 +507,7 @@ module Twilio
           end
 
           ##
-          # Fetch a AssistantInstance
+          # Fetch the AssistantInstance
           # @return [AssistantInstance] Fetched AssistantInstance
           def fetch
             context.fetch
@@ -564,7 +547,7 @@ module Twilio
           end
 
           ##
-          # Deletes the AssistantInstance
+          # Delete the AssistantInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete

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

@@ -81,16 +81,10 @@ module Twilio
             end
 
             ##
-            # Fetch a AssistantFallbackActionsInstance
+            # Fetch the AssistantFallbackActionsInstance
             # @return [AssistantFallbackActionsInstance] Fetched AssistantFallbackActionsInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               AssistantFallbackActionsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
@@ -102,11 +96,7 @@ module Twilio
             def update(fallback_actions: :unset)
               data = Twilio::Values.of({'FallbackActions' => Twilio.serialize_object(fallback_actions), })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               AssistantFallbackActionsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
@@ -187,7 +177,7 @@ module Twilio
             end
 
             ##
-            # Fetch a AssistantFallbackActionsInstance
+            # Fetch the AssistantFallbackActionsInstance
             # @return [AssistantFallbackActionsInstance] Fetched AssistantFallbackActionsInstance
             def fetch
               context.fetch