twilio-ruby 5.35.0 → 5.36.0

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

@@ -0,0 +1,266 @@
+##
+# 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
+            ##
+            # 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
+              # @param [String] business_sid The unique SID identifier of the Business.
+              # @param [String] brand_sid The unique SID identifier of the Brand.
+              # @return [BrandedChannelList] BrandedChannelList
+              def initialize(version, business_sid: nil, brand_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {business_sid: business_sid, brand_sid: brand_sid}
+              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,
+                    business_sid: @solution[:business_sid],
+                    brand_sid: @solution[:brand_sid],
+                )
+              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] business_sid The unique SID identifier of the Business.
+              # @param [String] brand_sid The unique SID identifier of the Brand.
+              # @param [String] sid The unique SID identifier of the Branded Channel.
+              # @return [BrandedChannelContext] BrandedChannelContext
+              def initialize(version, business_sid, brand_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {business_sid: business_sid, brand_sid: brand_sid, sid: sid, }
+                @uri = "/Businesses/#{@solution[:business_sid]}/Brands/#{@solution[:brand_sid]}/BrandedChannels/#{@solution[:sid]}"
+
+                # Dependents
+                @channels = nil
+              end
+
+              ##
+              # Fetch a BrandedChannelInstance
+              # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                BrandedChannelInstance.new(
+                    @version,
+                    payload,
+                    business_sid: @solution[:business_sid],
+                    brand_sid: @solution[:brand_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Access the channels
+              # @return [ChannelList]
+              # @return [ChannelContext]
+              def channels
+                unless @channels
+                  @channels = ChannelList.new(
+                      @version,
+                      business_sid: @solution[:business_sid],
+                      brand_sid: @solution[:brand_sid],
+                      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] business_sid The unique SID identifier of the Business.
+              # @param [String] brand_sid The unique SID identifier of the Brand.
+              # @param [String] sid The unique SID identifier of the Branded Channel.
+              # @return [BrandedChannelInstance] BrandedChannelInstance
+              def initialize(version, payload, business_sid: nil, brand_sid: nil, 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 = {
+                    'business_sid' => business_sid,
+                    'brand_sid' => brand_sid,
+                    '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['business_sid'],
+                      @params['brand_sid'],
+                      @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 a 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
+  end
+end

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

@@ -0,0 +1,197 @@
+##
+# 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
+
+                ##
+                # Retrieve a single page of ChannelInstance records from the API.
+                # Request is executed immediately.
+                # @param [String] phone_number_sid The unique SID identifier of the Phone Number
+                #   of the Phone number to be assigned to the Branded Channel.
+                # @param [String] phone_number The phone number given in [E.164
+                #   format](https://www.twilio.com/docs/glossary/what-e164) to assign to the Branded
+                #   Channel. It must be a Twilio number that from your account.
+                # @return [ChannelInstance] Newly created ChannelInstance
+                def create(phone_number_sid: nil, phone_number: nil)
+                  data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, 'PhoneNumber' => phone_number, })
+
+                  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