twilio-ruby 5.20.0 → 5.47.0

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

@@ -0,0 +1,165 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < Version
+        class BrandedChannelContext < 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 ChannelList < ListResource
+            ##
+            # Initialize the ChannelList
+            # @param [Version] version Version that contains the resource
+            # @param [String] branded_channel_sid The unique SID identifier of the Branded
+            #   Channel.
+            # @return [ChannelList] ChannelList
+            def initialize(version, branded_channel_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {branded_channel_sid: branded_channel_sid}
+              @uri = "/BrandedChannels/#{@solution[:branded_channel_sid]}/Channels"
+            end
+
+            ##
+            # Create the ChannelInstance
+            # @param [String] phone_number_sid The unique SID identifier of the Phone Number
+            #   of the Phone number to be assigned to the Branded Channel.
+            # @return [ChannelInstance] Created ChannelInstance
+            def create(phone_number_sid: nil)
+              data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              ChannelInstance.new(@version, payload, branded_channel_sid: @solution[:branded_channel_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.TrustedComms.ChannelList>'
+            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 ChannelPage < Page
+            ##
+            # Initialize the ChannelPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [ChannelPage] ChannelPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of ChannelInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [ChannelInstance] ChannelInstance
+            def get_instance(payload)
+              ChannelInstance.new(@version, payload, branded_channel_sid: @solution[:branded_channel_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.TrustedComms.ChannelPage>'
+            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 ChannelInstance < InstanceResource
+            ##
+            # Initialize the ChannelInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] branded_channel_sid The unique SID identifier of the Branded
+            #   Channel.
+            # @return [ChannelInstance] ChannelInstance
+            def initialize(version, payload, branded_channel_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'business_sid' => payload['business_sid'],
+                  'brand_sid' => payload['brand_sid'],
+                  'branded_channel_sid' => payload['branded_channel_sid'],
+                  'phone_number_sid' => payload['phone_number_sid'],
+                  'phone_number' => payload['phone_number'],
+                  'url' => payload['url'],
+              }
+            end
+
+            ##
+            # @return [String] Account Sid.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] Business Sid.
+            def business_sid
+              @properties['business_sid']
+            end
+
+            ##
+            # @return [String] Brand Sid.
+            def brand_sid
+              @properties['brand_sid']
+            end
+
+            ##
+            # @return [String] Branded Channel Sid.
+            def branded_channel_sid
+              @properties['branded_channel_sid']
+            end
+
+            ##
+            # @return [String] Phone Number Sid to be branded.
+            def phone_number_sid
+              @properties['phone_number_sid']
+            end
+
+            ##
+            # @return [String] Twilio number to assign to the Branded Channel
+            def phone_number
+              @properties['phone_number']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Preview.TrustedComms.ChannelInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Preview.TrustedComms.ChannelInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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