twilio-ruby 5.40.3 → 5.74.1

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

@@ -0,0 +1,156 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FlexApi < Domain
+      class V1 < Version
+        class AssessmentsList < ListResource
+          ##
+          # Initialize the AssessmentsList
+          # @param [Version] version Version that contains the resource
+          # @return [AssessmentsList] AssessmentsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FlexApi.V1.AssessmentsList>'
+          end
+        end
+
+        class AssessmentsPage < Page
+          ##
+          # Initialize the AssessmentsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [AssessmentsPage] AssessmentsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of AssessmentsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [AssessmentsInstance] AssessmentsInstance
+          def get_instance(payload)
+            AssessmentsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FlexApi.V1.AssessmentsPage>'
+          end
+        end
+
+        class AssessmentsContext < InstanceContext
+          ##
+          # Initialize the AssessmentsContext
+          # @param [Version] version Version that contains the resource
+          # @return [AssessmentsContext] AssessmentsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Accounts/Assessments"
+          end
+
+          ##
+          # Create the AssessmentsInstance
+          # @return [AssessmentsInstance] Created AssessmentsInstance
+          def create
+            payload = @version.create('POST', @uri)
+
+            AssessmentsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.AssessmentsContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FlexApi.V1.AssessmentsContext #{context}>"
+          end
+        end
+
+        class AssessmentsInstance < InstanceResource
+          ##
+          # Initialize the AssessmentsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [AssessmentsInstance] AssessmentsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'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 [AssessmentsContext] AssessmentsContext for this AssessmentsInstance
+          def context
+            unless @instance_context
+              @instance_context = AssessmentsContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Create the AssessmentsInstance
+          # @return [AssessmentsInstance] Created AssessmentsInstance
+          def create
+            context.create
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.AssessmentsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FlexApi.V1.AssessmentsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -105,7 +105,7 @@ module Twilio
 
           ##
           # Create the ChannelInstance
-          # @param [String] flex_flow_sid The SID of the FlexFlow.
+          # @param [String] flex_flow_sid The SID of the Flex Flow.
           # @param [String] identity The `identity` value that uniquely identifies the new
           #   resource's chat User.
           # @param [String] chat_user_friendly_name The chat participant's friendly name.
@@ -114,9 +114,9 @@ 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. Only valid when
+          # @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
+          # @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.
           # @return [ChannelInstance] Created ChannelInstance
@@ -265,7 +265,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the FlexFlow
+          # @return [String] The SID of the Flex Flow
           def flex_flow_sid
             @properties['flex_flow_sid']
           end
@@ -283,7 +283,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the TaskRouter task
+          # @return [String] The SID of the TaskRouter Task
           def task_sid
             @properties['task_sid']
           end

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

@@ -164,7 +164,15 @@ module Twilio
                 'outbound_call_flows' => payload['outbound_call_flows'],
                 'serverless_service_sids' => payload['serverless_service_sids'],
                 'queue_stats_configuration' => payload['queue_stats_configuration'],
+                'notifications' => payload['notifications'],
+                'markdown' => payload['markdown'],
                 'url' => payload['url'],
+                'flex_insights_hr' => payload['flex_insights_hr'],
+                'flex_insights_drilldown' => payload['flex_insights_drilldown'],
+                'flex_url' => payload['flex_url'],
+                'channel_configs' => payload['channel_configs'],
+                'debugger_integration' => payload['debugger_integration'],
+                'flex_ui_status_report' => payload['flex_ui_status_report'],
             }
 
             # Context
@@ -232,13 +240,13 @@ module Twilio
           end
 
           ##
-          # @return [Hash] The list of TaskRouter TaskQueues
+          # @return [Array[Hash]] The list of TaskRouter TaskQueues
           def taskrouter_taskqueues
             @properties['taskrouter_taskqueues']
           end
 
           ##
-          # @return [Hash] The Skill description for TaskRouter workers
+          # @return [Array[Hash]] The Skill description for TaskRouter workers
           def taskrouter_skills
             @properties['taskrouter_skills']
           end
@@ -376,7 +384,7 @@ module Twilio
           end
 
           ##
-          # @return [Hash] A list of objects that contain the configurations for the Integrations supported in this configuration
+          # @return [Array[Hash]] A list of objects that contain the configurations for the Integrations supported in this configuration
           def integrations
             @properties['integrations']
           end
@@ -388,7 +396,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of serverless service SIDs
+          # @return [Array[String]] The list of serverless service SIDs
           def serverless_service_sids
             @properties['serverless_service_sids']
           end
@@ -399,12 +407,60 @@ module Twilio
             @properties['queue_stats_configuration']
           end
 
+          ##
+          # @return [Hash] Configurable parameters for Notifications
+          def notifications
+            @properties['notifications']
+          end
+
+          ##
+          # @return [Hash] Configurable parameters for Markdown
+          def markdown
+            @properties['markdown']
+          end
+
           ##
           # @return [String] The absolute URL of the Configuration resource
           def url
             @properties['url']
           end
 
+          ##
+          # @return [Hash] Object that controls workspace reporting
+          def flex_insights_hr
+            @properties['flex_insights_hr']
+          end
+
+          ##
+          # @return [Boolean] Setting to enable Flex UI redirection
+          def flex_insights_drilldown
+            @properties['flex_insights_drilldown']
+          end
+
+          ##
+          # @return [String] URL to redirect to in case drilldown is enabled.
+          def flex_url
+            @properties['flex_url']
+          end
+
+          ##
+          # @return [Array[Hash]] Flex Conversations channels' attachments configurations
+          def channel_configs
+            @properties['channel_configs']
+          end
+
+          ##
+          # @return [Hash] Configurable parameters for Debugger Integration
+          def debugger_integration
+            @properties['debugger_integration']
+          end
+
+          ##
+          # @return [Hash] Configurable parameters for Flex UI Status report
+          def flex_ui_status_report
+            @properties['flex_ui_status_report']
+          end
+
           ##
           # Fetch the ConfigurationInstance
           # @param [String] ui_version The Pinned UI version of the Configuration resource

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

@@ -27,7 +27,7 @@ module Twilio
           # Lists FlexFlowInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
@@ -44,7 +44,7 @@ module Twilio
           # Streams FlexFlowInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
@@ -78,7 +78,7 @@ module Twilio
           ##
           # Retrieve a single page of FlexFlowInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
@@ -113,42 +113,53 @@ module Twilio
           ##
           # Create the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the new FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task for
-          #   Task `integration_type`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   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] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message In the context of outbound
+          #   messaging, defines whether to create a Task immediately (and therefore reserve
+          #   the conversation to current agent), or delay Task creation until the customer
+          #   sends the first response. Set to false to create immediately, true to delay Task
+          #   creation. This setting is only applicable for outbound messaging.
           # @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.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Created FlexFlowInstance
           def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -216,7 +227,7 @@ module Twilio
           ##
           # Initialize the FlexFlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The SID of the FlexFlow resource to fetch.
+          # @param [String] sid The SID of the Flex Flow resource to fetch.
           # @return [FlexFlowContext] FlexFlowContext
           def initialize(version, sid)
             super(version)
@@ -238,42 +249,53 @@ module Twilio
           ##
           # Update the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   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] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message In the context of outbound
+          #   messaging, defines whether to create a Task immediately (and therefore reserve
+          #   the conversation to current agent), or delay Task creation until the customer
+          #   sends the first response. Set to false to create immediately, true to delay Task
+          #   creation. This setting is only applicable for outbound messaging.
           # @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.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -328,7 +350,7 @@ module Twilio
           # Initialize the FlexFlowInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The SID of the FlexFlow resource to fetch.
+          # @param [String] sid The SID of the Flex Flow resource to fetch.
           # @return [FlexFlowInstance] FlexFlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -416,13 +438,13 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Whether the FlexFlow is enabled
+          # @return [Boolean] Whether the Flex Flow is enabled
           def enabled
             @properties['enabled']
           end
 
           ##
-          # @return [flex_flow.IntegrationType] The integration type
+          # @return [flex_flow.IntegrationType] The software that will handle inbound messages.
           def integration_type
             @properties['integration_type']
           end
@@ -446,7 +468,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The absolute URL of the FlexFlow resource
+          # @return [String] The absolute URL of the Flex Flow resource
           def url
             @properties['url']
           end
@@ -461,42 +483,53 @@ module Twilio
           ##
           # Update the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   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] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type The software that will
+          #   handle inbound messages. {Integration
+          #   Type}[https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types]
+          #   can be: `studio`, `external`, or `task`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel The Task Channel SID (TCXXXX) or unique name
+          #   (e.g., `sms`) to use for the Task that will be created. Applicable and required
+          #   when `integrationType` is `task`. The default value is `default`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message In the context of outbound
+          #   messaging, defines whether to create a Task immediately (and therefore reserve
+          #   the conversation to current agent), or delay Task creation until the customer
+          #   sends the first response. Set to false to create immediately, true to delay Task
+          #   creation. This setting is only applicable for outbound messaging.
           # @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.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             context.update(