twilio-ruby 4.13.0 → 5.40.0

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

@@ -0,0 +1,243 @@
+##
+# 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 BrandedCallList < ListResource
+          ##
+          # Initialize the BrandedCallList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandedCallList] BrandedCallList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Business/BrandedCalls"
+          end
+
+          ##
+          # Create the BrandedCallInstance
+          # @param [String] from The phone number to use as the caller id, given in [E.164
+          #   format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio
+          #   number that has been set up as a Branded Number in the Business Profile section
+          #   for your account.
+          # @param [String] to The terminating Phone Number, given in [E.164
+          #   format](https://www.twilio.com/docs/glossary/what-e164).
+          # @param [String] reason The business reason for this phone call that will appear
+          #   in the terminating device's screen. Max 50 characters.
+          # @param [String] call_sid The Call sid this Branded Call should link to.
+          # @return [BrandedCallInstance] Created BrandedCallInstance
+          def create(from: nil, to: nil, reason: nil, call_sid: :unset)
+            data = Twilio::Values.of({'From' => from, 'To' => to, 'Reason' => reason, 'CallSid' => call_sid, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            BrandedCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.BrandedCallList>'
+          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 BrandedCallPage < Page
+          ##
+          # Initialize the BrandedCallPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandedCallPage] BrandedCallPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandedCallInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandedCallInstance] BrandedCallInstance
+          def get_instance(payload)
+            BrandedCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.BrandedCallPage>'
+          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 BrandedCallInstance < InstanceResource
+          ##
+          # Initialize the BrandedCallInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [BrandedCallInstance] BrandedCallInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'bg_color' => payload['bg_color'],
+                'brand_sid' => payload['brand_sid'],
+                'branded_channel_sid' => payload['branded_channel_sid'],
+                'business_sid' => payload['business_sid'],
+                'call_sid' => payload['call_sid'],
+                'caller' => payload['caller'],
+                'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                'font_color' => payload['font_color'],
+                'from' => payload['from'],
+                'logo' => payload['logo'],
+                'phone_number_sid' => payload['phone_number_sid'],
+                'reason' => payload['reason'],
+                'sid' => payload['sid'],
+                'status' => payload['status'],
+                'to' => payload['to'],
+                'url' => payload['url'],
+                'use_case' => payload['use_case'],
+            }
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] Background color of the current phone call
+          def bg_color
+            @properties['bg_color']
+          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] Business Sid.
+          def business_sid
+            @properties['business_sid']
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this phone call.
+          def call_sid
+            @properties['call_sid']
+          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] Phone Number Sid.
+          def phone_number_sid
+            @properties['phone_number_sid']
+          end
+
+          ##
+          # @return [String] The business reason for this current phone call
+          def reason
+            @properties['reason']
+          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
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Preview.TrustedComms.BrandedCallInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Preview.TrustedComms.BrandedCallInstance>"
+          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/business/brand/branded_channel/channel.rb

@@ -0,0 +1,189 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < Version
+        class BusinessContext < InstanceContext
+          class BrandContext < InstanceContext
+            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] business_sid The unique SID identifier of the Business.
+                # @param [String] brand_sid The unique SID identifier of the Brand.
+                # @param [String] branded_channel_sid The unique SID identifier of the Branded
+                #   Channel.
+                # @return [ChannelList] ChannelList
+                def initialize(version, business_sid: nil, brand_sid: nil, branded_channel_sid: nil)
+                  super(version)
+
+                  # Path Solution
+                  @solution = {
+                      business_sid: business_sid,
+                      brand_sid: brand_sid,
+                      branded_channel_sid: branded_channel_sid
+                  }
+                  @uri = "/Businesses/#{@solution[:business_sid]}/Brands/#{@solution[:brand_sid]}/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,
+                      business_sid: @solution[:business_sid],
+                      brand_sid: @solution[:brand_sid],
+                      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,
+                      business_sid: @solution[:business_sid],
+                      brand_sid: @solution[:brand_sid],
+                      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] business_sid The unique SID identifier of the Business.
+                # @param [String] brand_sid The unique SID identifier of the Brand.
+                # @param [String] branded_channel_sid The unique SID identifier of the Branded
+                #   Channel.
+                # @return [ChannelInstance] ChannelInstance
+                def initialize(version, payload, business_sid: nil, brand_sid: nil, 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
+  end
+end