twilio-ruby 5.40.1 → 5.42.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/business.rb

@@ -79,7 +79,6 @@ module Twilio
             @uri = "/Businesses/#{@solution[:sid]}"
 
             # Dependents
-            @brands = nil
             @insights = nil
           end
 
@@ -92,24 +91,6 @@ module Twilio
             BusinessInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
-          ##
-          # Access the brands
-          # @return [BrandList]
-          # @return [BrandContext] if sid was passed.
-          def brands(sid=:unset)
-            raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-            if sid != :unset
-              return BrandContext.new(@version, @solution[:sid], sid, )
-            end
-
-            unless @brands
-              @brands = BrandList.new(@version, business_sid: @solution[:sid], )
-            end
-
-            @brands
-          end
-
           ##
           # Access the insights
           # @return [InsightsList]
@@ -205,13 +186,6 @@ module Twilio
             context.fetch
           end
 
-          ##
-          # Access the brands
-          # @return [brands] brands
-          def brands
-            context.brands
-          end
-
           ##
           # Access the insights
           # @return [insights] insights

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

@@ -32,12 +32,9 @@ module Twilio
 
             ##
             # Access the impressions_rate
-            # @return [ImpressionsRateList]
-            # @return [ImpressionsRateContext]
+            # @return [ImpressionsRateContext] ImpressionsRateContext
             def impressions_rate
               return ImpressionsRateContext.new(@version, @solution[:business_sid], )
-
-              @impressions_rate ||= ImpressionsRateList.new(@version, business_sid: @solution[:business_sid], )
             end
 
             ##

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

@@ -80,11 +80,11 @@ module Twilio
           ##
           # 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).
+          #   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).
+          #   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({
@@ -244,11 +244,11 @@ module Twilio
           ##
           # 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).
+          #   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).
+          #   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(

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

@@ -27,86 +27,86 @@ module Twilio
 
           ##
           # Create the PhoneCallInstance
-          # @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] application_sid Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] caller_id Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] fallback_method Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] fallback_url Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] machine_detection Refers to the parameter with the same name
-          #   when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] machine_detection_silence_timeout Refers to the parameter with
-          #   the same name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   the same name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] machine_detection_speech_end_threshold Refers to the parameter
-          #   with the same name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   with the same name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] machine_detection_speech_threshold Refers to the parameter with
-          #   the same name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   the same name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] machine_detection_timeout Refers to the parameter with the same
-          #   name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] method Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [Boolean] record Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] recording_channels Refers to the parameter with the same name
-          #   when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] recording_status_callback Refers to the parameter with the same
-          #   name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] recording_status_callback_event Refers to the parameter with the
-          #   same name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   same name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] recording_status_callback_method Refers to the parameter with
-          #   the same name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   the same name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] send_digits Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] sip_auth_password Refers to the parameter with the same name
-          #   when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] sip_auth_username Refers to the parameter with the same name
-          #   when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] status_callback Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] status_callback_event Refers to the parameter with the same name
-          #   when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] status_callback_method Refers to the parameter with the same
-          #   name when [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   name when {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @param [String] timeout Refers to the parameter with the same name when
-          #   [initiating a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
-          # @param [String] trim Refers to the parameter with the same name when [initiating
+          #   {initiating a call via Voice
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
+          # @param [String] trim Refers to the parameter with the same name when {initiating
           #   a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
-          # @param [String] url Refers to the parameter with the same name when [initiating
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
+          # @param [String] url Refers to the parameter with the same name when {initiating
           #   a call via Voice
-          #   API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)
+          #   API}[https://www.twilio.com/docs/voice/api/call#create-a-call-resource]
           # @return [PhoneCallInstance] Created PhoneCallInstance
           def create(from: nil, to: nil, reason: :unset, application_sid: :unset, caller_id: :unset, fallback_method: :unset, fallback_url: :unset, machine_detection: :unset, machine_detection_silence_timeout: :unset, machine_detection_speech_end_threshold: :unset, machine_detection_speech_threshold: :unset, machine_detection_timeout: :unset, method: :unset, record: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_event: :unset, recording_status_callback_method: :unset, send_digits: :unset, sip_auth_password: :unset, sip_auth_username: :unset, status_callback: :unset, status_callback_event: :unset, status_callback_method: :unset, timeout: :unset, trim: :unset, url: :unset)
             data = Twilio::Values.of({

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

@@ -112,8 +112,8 @@ module Twilio
               ##
               # Create the FieldInstance
               # @param [String] field_type The unique name or sid of the FieldType. It can be
-              #   any [Built-in Field
-              #   Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the
+              #   any {Built-in Field
+              #   Type}[https://www.twilio.com/docs/assistant/api/built-in-field-types] or the
               #   unique_name or the Field Type sid of a custom Field Type.
               # @param [String] unique_name A user-provided string that uniquely identifies this
               #   resource as an alternative to the sid. Unique up to 64 characters long.

data/lib/twilio-ruby/rest/pricing/v1/messaging.rb

@@ -27,8 +27,8 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country The [ISO country
-          #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing
+          # @param [String] iso_country The {ISO country
+          #   code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing
           #   information to fetch.
           # @return [CountryList]
           # @return [CountryContext] if iso_country was passed.

data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb

@@ -144,8 +144,8 @@ module Twilio
             ##
             # Initialize the CountryContext
             # @param [Version] version Version that contains the resource
-            # @param [String] iso_country The [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing
+            # @param [String] iso_country The {ISO country
+            #   code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing
             #   information to fetch.
             # @return [CountryContext] CountryContext
             def initialize(version, iso_country)
@@ -185,8 +185,8 @@ module Twilio
             # Initialize the CountryInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] iso_country The [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing
+            # @param [String] iso_country The {ISO country
+            #   code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing
             #   information to fetch.
             # @return [CountryInstance] CountryInstance
             def initialize(version, payload, iso_country: nil)

data/lib/twilio-ruby/rest/pricing/v1/phone_number.rb

@@ -27,8 +27,8 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_country The [ISO country
-          #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing
+          # @param [String] iso_country The {ISO country
+          #   code}[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the pricing
           #   information to fetch.
           # @return [CountryList]
           # @return [CountryContext] if iso_country was passed.