twilio-ruby 5.40.0 → 5.41.0

data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb

@@ -34,8 +34,9 @@ module Twilio
             # memory before returning.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+            #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.
             # @param [String] incoming_phone_number_sid A 34 character string that uniquely
@@ -70,8 +71,9 @@ module Twilio
             # is reached.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+            #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.
             # @param [String] incoming_phone_number_sid A 34 character string that uniquely
@@ -122,8 +124,9 @@ module Twilio
             # Request is executed immediately.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
+            #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.
             # @param [String] incoming_phone_number_sid A 34 character string that uniquely

data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb

@@ -164,7 +164,7 @@ module Twilio
           ##
           # Create the HostedNumberOrderInstance
           # @param [String] phone_number The number to host in
-          #   [+E.164](https://en.wikipedia.org/wiki/E.164) format
+          #   {+E.164}[https://en.wikipedia.org/wiki/E.164] format
           # @param [Boolean] sms_capability Used to specify that the SMS capability will be
           #   hosted on Twilio's platform.
           # @param [String] account_sid This defaults to the AccountSid of the authorization

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

@@ -16,6 +16,7 @@ module Twilio
           super
           @version = 'TrustedComms'
           @branded_calls = nil
+          @branded_channels = nil
           @brands_information = nil
           @businesses = nil
           @cps = nil
@@ -29,6 +30,20 @@ module Twilio
           @branded_calls ||= BrandedCallList.new self
         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'
+          elsif sid == :unset
+            @branded_channels ||= BrandedChannelList.new self
+          else
+            BrandedChannelContext.new(self, sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationContext]
         def brands_information

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

@@ -27,12 +27,12 @@ module Twilio
 
           ##
           # 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
+          # @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] 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.

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

@@ -0,0 +1,225 @@
+##
+# 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 BrandedChannelList < ListResource
+          ##
+          # Initialize the BrandedChannelList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandedChannelList] BrandedChannelList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.BrandedChannelList>'
+          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 BrandedChannelPage < Page
+          ##
+          # Initialize the BrandedChannelPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandedChannelPage] BrandedChannelPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandedChannelInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandedChannelInstance] BrandedChannelInstance
+          def get_instance(payload)
+            BrandedChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.BrandedChannelPage>'
+          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 BrandedChannelContext < InstanceContext
+          ##
+          # Initialize the BrandedChannelContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The unique SID identifier of the Branded Channel.
+          # @return [BrandedChannelContext] BrandedChannelContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/BrandedChannels/#{@solution[:sid]}"
+
+            # Dependents
+            @channels = nil
+          end
+
+          ##
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            BrandedChannelInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the channels
+          # @return [ChannelList]
+          # @return [ChannelContext]
+          def channels
+            unless @channels
+              @channels = ChannelList.new(@version, branded_channel_sid: @solution[:sid], )
+            end
+
+            @channels
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandedChannelContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BrandedChannelContext #{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 BrandedChannelInstance < InstanceResource
+          ##
+          # Initialize the BrandedChannelInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The unique SID identifier of the Branded Channel.
+          # @return [BrandedChannelInstance] BrandedChannelInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'business_sid' => payload['business_sid'],
+                'brand_sid' => payload['brand_sid'],
+                'sid' => payload['sid'],
+                'links' => payload['links'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [BrandedChannelContext] BrandedChannelContext for this BrandedChannelInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandedChannelContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          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 sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the channels
+          # @return [channels] channels
+          def channels
+            context.channels
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandedChannelInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandedChannelInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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