twilio-ruby 4.13.0 → 5.40.0

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

@@ -0,0 +1,260 @@
+##
+# 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 InsightsList < ListResource
+            ##
+            # 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 ImpressionsRateList < ListResource
+              ##
+              # Initialize the ImpressionsRateList
+              # @param [Version] version Version that contains the resource
+              # @param [String] business_sid A 34 character string that uniquely identifies this
+              #   Business.
+              # @return [ImpressionsRateList] ImpressionsRateList
+              def initialize(version, business_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {business_sid: business_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Preview.TrustedComms.ImpressionsRateList>'
+              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 ImpressionsRatePage < Page
+              ##
+              # Initialize the ImpressionsRatePage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [ImpressionsRatePage] ImpressionsRatePage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of ImpressionsRateInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [ImpressionsRateInstance] ImpressionsRateInstance
+              def get_instance(payload)
+                ImpressionsRateInstance.new(@version, payload, business_sid: @solution[:business_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Preview.TrustedComms.ImpressionsRatePage>'
+              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 ImpressionsRateContext < InstanceContext
+              ##
+              # Initialize the ImpressionsRateContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] business_sid The unique SID identifier of the Business to filter
+              #   by.
+              # @return [ImpressionsRateContext] ImpressionsRateContext
+              def initialize(version, business_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {business_sid: business_sid, }
+                @uri = "/Businesses/#{@solution[:business_sid]}/Insights/ImpressionsRate"
+              end
+
+              ##
+              # Fetch the ImpressionsRateInstance
+              # @param [String] brand_sid The unique SID identifier of the Brand to filter by.
+              # @param [String] branded_channel_sid The unique SID identifier of the Branded
+              #   Channel to filter by.
+              # @param [String] phone_number_sid The unique SID identifier of the Phone Number
+              #   to filter by.
+              # @param [String] country The 2-letter ISO 3166 code of the Country to filter by.
+              # @param [Time] start The start date that for this Impressions Rate, given in ISO
+              #   8601 format. Default value is 30 days ago.
+              # @param [Time] end_ The end date that for this Impressions Rate, given in ISO
+              #   8601 format. Default value is current timestamp.
+              # @param [impressions_rate.Intervals] interval The Interval of this Impressions
+              #   Rate. One of `minute`, `hour`, `day`, `week` or `month`.
+              # @return [ImpressionsRateInstance] Fetched ImpressionsRateInstance
+              def fetch(brand_sid: :unset, branded_channel_sid: :unset, phone_number_sid: :unset, country: :unset, start: :unset, end_: :unset, interval: :unset)
+                params = Twilio::Values.of({
+                    'BrandSid' => brand_sid,
+                    'BrandedChannelSid' => branded_channel_sid,
+                    'PhoneNumberSid' => phone_number_sid,
+                    'Country' => country,
+                    'Start' => Twilio.serialize_iso8601_datetime(start),
+                    'End' => Twilio.serialize_iso8601_datetime(end_),
+                    'Interval' => interval,
+                })
+
+                payload = @version.fetch('GET', @uri, params: params)
+
+                ImpressionsRateInstance.new(@version, payload, business_sid: @solution[:business_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.TrustedComms.ImpressionsRateContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.TrustedComms.ImpressionsRateContext #{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 ImpressionsRateInstance < InstanceResource
+              ##
+              # Initialize the ImpressionsRateInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] business_sid A 34 character string that uniquely identifies this
+              #   Business.
+              # @return [ImpressionsRateInstance] ImpressionsRateInstance
+              def initialize(version, payload, business_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'business_sid' => payload['business_sid'],
+                    'end_' => Twilio.deserialize_iso8601_datetime(payload['end']),
+                    'interval' => payload['interval'],
+                    'reports' => payload['reports'],
+                    'start' => Twilio.deserialize_iso8601_datetime(payload['start']),
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'business_sid' => business_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 [ImpressionsRateContext] ImpressionsRateContext for this ImpressionsRateInstance
+              def context
+                unless @instance_context
+                  @instance_context = ImpressionsRateContext.new(@version, @params['business_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 [Time] The end date that for this Impressions Rate.
+              def end_
+                @properties['end_']
+              end
+
+              ##
+              # @return [impressions_rate.Intervals] The Interval of this Impressions Rate.
+              def interval
+                @properties['interval']
+              end
+
+              ##
+              # @return [Hash] Values of Impressions Rate per interval.
+              def reports
+                @properties['reports']
+              end
+
+              ##
+              # @return [Time] The start date that for this Impressions Rate.
+              def start
+                @properties['start']
+              end
+
+              ##
+              # @return [String] The URL of this resource.
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch the ImpressionsRateInstance
+              # @param [String] brand_sid The unique SID identifier of the Brand to filter by.
+              # @param [String] branded_channel_sid The unique SID identifier of the Branded
+              #   Channel to filter by.
+              # @param [String] phone_number_sid The unique SID identifier of the Phone Number
+              #   to filter by.
+              # @param [String] country The 2-letter ISO 3166 code of the Country to filter by.
+              # @param [Time] start The start date that for this Impressions Rate, given in ISO
+              #   8601 format. Default value is 30 days ago.
+              # @param [Time] end_ The end date that for this Impressions Rate, given in ISO
+              #   8601 format. Default value is current timestamp.
+              # @param [impressions_rate.Intervals] interval The Interval of this Impressions
+              #   Rate. One of `minute`, `hour`, `day`, `week` or `month`.
+              # @return [ImpressionsRateInstance] Fetched ImpressionsRateInstance
+              def fetch(brand_sid: :unset, branded_channel_sid: :unset, phone_number_sid: :unset, country: :unset, start: :unset, end_: :unset, interval: :unset)
+                context.fetch(
+                    brand_sid: brand_sid,
+                    branded_channel_sid: branded_channel_sid,
+                    phone_number_sid: phone_number_sid,
+                    country: country,
+                    start: start,
+                    end_: end_,
+                    interval: interval,
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Preview.TrustedComms.ImpressionsRateInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Preview.TrustedComms.ImpressionsRateInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+##
+# 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
+          ##
+          # 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 InsightsList < ListResource
+            ##
+            # Initialize the InsightsList
+            # @param [Version] version Version that contains the resource
+            # @param [String] business_sid A 34 character string that uniquely identifies this
+            #   Business.
+            # @return [InsightsList] InsightsList
+            def initialize(version, business_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {business_sid: business_sid}
+
+              # Components
+              @impressions_rate = nil
+            end
+
+            ##
+            # Access the impressions_rate
+            # @return [ImpressionsRateList]
+            # @return [ImpressionsRateContext]
+            def impressions_rate
+              return ImpressionsRateContext.new(@version, @solution[:business_sid], )
+
+              @impressions_rate ||= ImpressionsRateList.new(@version, business_sid: @solution[:business_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.TrustedComms.InsightsList>'
+            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 InsightsPage < Page
+            ##
+            # Initialize the InsightsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [InsightsPage] InsightsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of InsightsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [InsightsInstance] InsightsInstance
+            def get_instance(payload)
+              InsightsInstance.new(@version, payload, business_sid: @solution[:business_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.TrustedComms.InsightsPage>'
+            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 InsightsInstance < InstanceResource
+            ##
+            # Initialize the InsightsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] business_sid A 34 character string that uniquely identifies this
+            #   Business.
+            # @return [InsightsInstance] InsightsInstance
+            def initialize(version, payload, business_sid: nil)
+              super(version)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Preview.TrustedComms.InsightsInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Preview.TrustedComms.InsightsInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,239 @@
+##
+# 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 BusinessList < ListResource
+          ##
+          # Initialize the BusinessList
+          # @param [Version] version Version that contains the resource
+          # @return [BusinessList] BusinessList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.BusinessList>'
+          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 BusinessPage < Page
+          ##
+          # Initialize the BusinessPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BusinessPage] BusinessPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BusinessInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BusinessInstance] BusinessInstance
+          def get_instance(payload)
+            BusinessInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.BusinessPage>'
+          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 BusinessContext < InstanceContext
+          ##
+          # Initialize the BusinessContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   Business.
+          # @return [BusinessContext] BusinessContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Businesses/#{@solution[:sid]}"
+
+            # Dependents
+            @brands = nil
+            @insights = nil
+          end
+
+          ##
+          # Fetch the BusinessInstance
+          # @return [BusinessInstance] Fetched BusinessInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            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]
+          # @return [InsightsContext]
+          def insights
+            unless @insights
+              @insights = InsightsList.new(@version, business_sid: @solution[:sid], )
+            end
+
+            @insights
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BusinessContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.BusinessContext #{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 BusinessInstance < InstanceResource
+          ##
+          # Initialize the BusinessInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   Business.
+          # @return [BusinessInstance] BusinessInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'sid' => payload['sid'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [BusinessContext] BusinessContext for this BusinessInstance
+          def context
+            unless @instance_context
+              @instance_context = BusinessContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Business.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch the BusinessInstance
+          # @return [BusinessInstance] Fetched BusinessInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the brands
+          # @return [brands] brands
+          def brands
+            context.brands
+          end
+
+          ##
+          # Access the insights
+          # @return [insights] insights
+          def insights
+            context.insights
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BusinessInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BusinessInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end