twilio-ruby 5.34.0 → 5.38.0

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb

@@ -0,0 +1,324 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Numbers < Domain
+      class V2 < Version
+        class RegulatoryComplianceList < ListResource
+          class BundleContext < InstanceContext
+            class EvaluationList < ListResource
+              ##
+              # Initialize the EvaluationList
+              # @param [Version] version Version that contains the resource
+              # @param [String] bundle_sid The unique string that we created to identify the
+              #   Bundle resource.
+              # @return [EvaluationList] EvaluationList
+              def initialize(version, bundle_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {bundle_sid: bundle_sid}
+                @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Evaluations"
+              end
+
+              ##
+              # Retrieve a single page of EvaluationInstance records from the API.
+              # Request is executed immediately.
+              # @return [EvaluationInstance] Newly created EvaluationInstance
+              def create
+                data = Twilio::Values.of({})
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                EvaluationInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid], )
+              end
+
+              ##
+              # Lists EvaluationInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit.  Default is no limit
+              # @param [Integer] page_size Number of records to fetch per request, when
+              #    not set will use the default value of 50 records.  If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Array] Array of up to limit results
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
+              end
+
+              ##
+              # Streams EvaluationInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [Integer] limit Upper limit for the number of records to return. stream()
+              #    guarantees to never return more than limit. Default is no limit.
+              # @param [Integer] page_size Number of records to fetch per request, when
+              #    not set will use the default value of 50 records. If no page_size is defined
+              #    but a limit is defined, stream() will attempt to read the limit with the most
+              #    efficient page size, i.e. min(limit, 1000)
+              # @return [Enumerable] Enumerable that will yield up to limit results
+              def stream(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields EvaluationInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              def each
+                limits = @version.read_limits
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page,
+                                limit: limits[:limit],
+                                page_limit: limits[:page_limit]).each {|x| yield x}
+              end
+
+              ##
+              # Retrieve a single page of EvaluationInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] page_token PageToken provided by the API
+              # @param [Integer] page_number Page Number, this value is simply for client state
+              # @param [Integer] page_size Number of records to return, defaults to 50
+              # @return [Page] Page of EvaluationInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+                response = @version.page(
+                    'GET',
+                    @uri,
+                    params
+                )
+                EvaluationPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of EvaluationInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of EvaluationInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                EvaluationPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Numbers.V2.EvaluationList>'
+              end
+            end
+
+            class EvaluationPage < Page
+              ##
+              # Initialize the EvaluationPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [EvaluationPage] EvaluationPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of EvaluationInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [EvaluationInstance] EvaluationInstance
+              def get_instance(payload)
+                EvaluationInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Numbers.V2.EvaluationPage>'
+              end
+            end
+
+            class EvaluationContext < InstanceContext
+              ##
+              # Initialize the EvaluationContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] bundle_sid The unique string that we created to identify the
+              #   Bundle resource.
+              # @param [String] sid The unique string that identifies the Evaluation resource.
+              # @return [EvaluationContext] EvaluationContext
+              def initialize(version, bundle_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {bundle_sid: bundle_sid, sid: sid, }
+                @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Evaluations/#{@solution[:sid]}"
+              end
+
+              ##
+              # Fetch a EvaluationInstance
+              # @return [EvaluationInstance] Fetched EvaluationInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                EvaluationInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid], sid: @solution[:sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Numbers.V2.EvaluationContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Numbers.V2.EvaluationContext #{context}>"
+              end
+            end
+
+            class EvaluationInstance < InstanceResource
+              ##
+              # Initialize the EvaluationInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] bundle_sid The unique string that we created to identify the
+              #   Bundle resource.
+              # @param [String] sid The unique string that identifies the Evaluation resource.
+              # @return [EvaluationInstance] EvaluationInstance
+              def initialize(version, payload, bundle_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'sid' => payload['sid'],
+                    'account_sid' => payload['account_sid'],
+                    'regulation_sid' => payload['regulation_sid'],
+                    'bundle_sid' => payload['bundle_sid'],
+                    'status' => payload['status'],
+                    'results' => payload['results'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'bundle_sid' => bundle_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 [EvaluationContext] EvaluationContext for this EvaluationInstance
+              def context
+                unless @instance_context
+                  @instance_context = EvaluationContext.new(@version, @params['bundle_sid'], @params['sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The unique string that identifies the Evaluation resource
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The unique string of a regulation
+              def regulation_sid
+                @properties['regulation_sid']
+              end
+
+              ##
+              # @return [String] The unique string that identifies the resource
+              def bundle_sid
+                @properties['bundle_sid']
+              end
+
+              ##
+              # @return [evaluation.Status] The compliance status of the Evaluation resource
+              def status
+                @properties['status']
+              end
+
+              ##
+              # @return [Hash] The results of the Evaluation resource
+              def results
+                @properties['results']
+              end
+
+              ##
+              # @return [Time] The date_created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [String] The url
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch a EvaluationInstance
+              # @return [EvaluationInstance] Fetched EvaluationInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Numbers.V2.EvaluationInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Numbers.V2.EvaluationInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -186,6 +186,12 @@ module Twilio
         self.trusted_comms.branded_calls()
       end
 
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationInstance]
+      def brands_information
+        self.trusted_comms.brands_information()
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this
       #   Business.

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

@@ -16,6 +16,7 @@ module Twilio
           super
           @version = 'TrustedComms'
           @branded_calls = nil
+          @brands_information = nil
           @businesses = nil
           @cps = nil
           @current_calls = nil
@@ -28,6 +29,12 @@ module Twilio
           @branded_calls ||= BrandedCallList.new self
         end
 
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationContext]
+        def brands_information
+          @brands_information ||= BrandsInformationContext.new self
+        end
+
         ##
         # @param [String] sid A 34 character string that uniquely identifies this
         #   Business.

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

@@ -0,0 +1,193 @@
+##
+# 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 a BrandsInformationInstance
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            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 a BrandsInformationInstance
+          # @return [BrandsInformationInstance] Fetched BrandsInformationInstance
+          def fetch
+            context.fetch
+          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