twilio-ruby 5.33.0 → 5.36.0

data/lib/twilio-ruby/rest/flex_api/v1/channel.rb

@@ -117,7 +117,8 @@ module Twilio
           #   of an SMS.
           # @param [String] chat_unique_name The chat channel's unique name.
           # @param [String] pre_engagement_data The pre-engagement data.
-          # @param [String] task_sid The SID of the TaskRouter task.
+          # @param [String] task_sid The SID of the TaskRouter task. Only valid when
+          #   integration type is `task`. `null` for integration types `studio` & `external`
           # @param [String] task_attributes The task attributes to be added for the
           #   TaskRouter Task.
           # @param [Boolean] long_lived Whether to create the channel as long-lived.

data/lib/twilio-ruby/rest/flex_api/v1/configuration.rb

@@ -161,6 +161,7 @@ module Twilio
                 'runtime_domain' => payload['runtime_domain'],
                 'messaging_service_instance_sid' => payload['messaging_service_instance_sid'],
                 'chat_service_instance_sid' => payload['chat_service_instance_sid'],
+                'flex_service_instance_sid' => payload['flex_service_instance_sid'],
                 'ui_language' => payload['ui_language'],
                 'ui_attributes' => payload['ui_attributes'],
                 'ui_dependencies' => payload['ui_dependencies'],
@@ -296,6 +297,12 @@ module Twilio
             @properties['chat_service_instance_sid']
           end
 
+          ##
+          # @return [String] The SID of the Flex service instance
+          def flex_service_instance_sid
+            @properties['flex_service_instance_sid']
+          end
+
           ##
           # @return [String] The primary language of the Flex UI
           def ui_language

data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb

@@ -143,9 +143,12 @@ module Twilio
           #   task is created with the channel. **Note** that does not apply when channel type
           #   is `web`. Setting the value to `true` for channel type `web` will result in
           #   misconfigured Flex Flow and no tasks will be created.
-          # @param [Boolean] long_lived Whether new channels are long-lived.
-          # @param [Boolean] janitor_enabled Boolean flag for enabling or disabling the
-          #   Janitor.
+          # @param [Boolean] long_lived When enabled, Flex will keep the chat channel active
+          #   so that it may be used for subsequent interactions with a contact identity.
+          #   Defaults to `false`.
+          # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
+          #   will remove active Proxy sessions if the associated Task is deleted outside of
+          #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
           #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
           #   the default is 0.
@@ -275,9 +278,12 @@ module Twilio
           #   task is created with the channel. **Note** that does not apply when channel type
           #   is `web`. Setting the value to `true` for channel type `web` will result in
           #   misconfigured Flex Flow and no tasks will be created.
-          # @param [Boolean] long_lived Whether new channels created are long-lived.
-          # @param [Boolean] janitor_enabled Boolean flag for enabling or disabling the
-          #   Janitor.
+          # @param [Boolean] long_lived When enabled, Flex will keep the chat channel active
+          #   so that it may be used for subsequent interactions with a contact identity.
+          #   Defaults to `false`.
+          # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
+          #   will remove active Proxy sessions if the associated Task is deleted outside of
+          #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
           #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
           #   the default is 0.
@@ -445,13 +451,13 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Whether new channels are long-lived
+          # @return [Boolean] Re-use this chat channel for future interactions with a contact
           def long_lived
             @properties['long_lived']
           end
 
           ##
-          # @return [Boolean] Boolean flag for enabling or disabling the Janitor
+          # @return [Boolean] Remove active Proxy sessions if the corresponding Task is deleted.
           def janitor_enabled
             @properties['janitor_enabled']
           end
@@ -499,9 +505,12 @@ module Twilio
           #   task is created with the channel. **Note** that does not apply when channel type
           #   is `web`. Setting the value to `true` for channel type `web` will result in
           #   misconfigured Flex Flow and no tasks will be created.
-          # @param [Boolean] long_lived Whether new channels created are long-lived.
-          # @param [Boolean] janitor_enabled Boolean flag for enabling or disabling the
-          #   Janitor.
+          # @param [Boolean] long_lived When enabled, Flex will keep the chat channel active
+          #   so that it may be used for subsequent interactions with a contact identity.
+          #   Defaults to `false`.
+          # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
+          #   will remove active Proxy sessions if the associated Task is deleted outside of
+          #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
           #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
           #   the default is 0.

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

@@ -242,6 +242,7 @@ module Twilio
               @uri = "/RegulatoryCompliance/Bundles/#{@solution[:sid]}"
 
               # Dependents
+              @evaluations = nil
               @item_assignments = nil
             end
 
@@ -287,6 +288,24 @@ module Twilio
               BundleInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
+            ##
+            # Access the evaluations
+            # @return [EvaluationList]
+            # @return [EvaluationContext] if sid was passed.
+            def evaluations(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return EvaluationContext.new(@version, @solution[:sid], sid, )
+              end
+
+              unless @evaluations
+                @evaluations = EvaluationList.new(@version, bundle_sid: @solution[:sid], )
+              end
+
+              @evaluations
+            end
+
             ##
             # Access the item_assignments
             # @return [ItemAssignmentList]
@@ -454,6 +473,13 @@ module Twilio
               )
             end
 
+            ##
+            # Access the evaluations
+            # @return [evaluations] evaluations
+            def evaluations
+              context.evaluations
+            end
+
             ##
             # Access the item_assignments
             # @return [item_assignments] item_assignments

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