twilio-ruby 5.44.0 → 5.47.0

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,33 +113,36 @@ 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 [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the new FlexFlow is enabled.
+          # @param [Boolean] enabled Whether the new Flex Flow 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 [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 for the TaskRouter Task
+          #   that will be created. Applicable and required when integrationType is `task`.
+          #   Set to `sms` for SMS, and to `chat` otherwise. 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`.
@@ -147,8 +150,9 @@ module Twilio
           #   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.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
+          #   default is 0. Optional when integrationType is `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 +220,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,33 +242,36 @@ 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 [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
+          # @param [Boolean] enabled Whether the new Flex Flow 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 [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 for the TaskRouter Task
+          #   that will be created. Applicable and required when integrationType is `task`.
+          #   Set to `sms` for SMS, and to `chat` otherwise. 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`.
@@ -272,8 +279,9 @@ module Twilio
           #   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.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
+          #   default is 0. Optional when integrationType is `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 +336,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,7 +424,7 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Whether the FlexFlow is enabled
+          # @return [Boolean] Whether the Flex Flow is enabled
           def enabled
             @properties['enabled']
           end
@@ -446,7 +454,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,33 +469,36 @@ 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 [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
+          # @param [Boolean] enabled Whether the new Flex Flow 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 [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 for the TaskRouter Task
+          #   that will be created. Applicable and required when integrationType is `task`.
+          #   Set to `sms` for SMS, and to `chat` otherwise. 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`.
@@ -495,8 +506,9 @@ module Twilio
           #   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.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (included),
+          #   default is 0. Optional when integrationType is `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(

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

@@ -105,7 +105,7 @@ module Twilio
 
           ##
           # Create the WebChannelInstance
-          # @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 chat identity.
           # @param [String] customer_friendly_name The chat participant's friendly name.
           # @param [String] chat_friendly_name The chat channel's friendly name.
@@ -268,7 +268,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

data/lib/twilio-ruby/rest/insights/v1/call/summary.rb

@@ -11,8 +11,6 @@ module Twilio
     class Insights < Domain
       class V1 < Version
         class CallContext < 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 CallSummaryList < ListResource
             ##
             # Initialize the CallSummaryList
@@ -33,8 +31,6 @@ module Twilio
             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 CallSummaryPage < Page
             ##
             # Initialize the CallSummaryPage
@@ -64,8 +60,6 @@ module Twilio
             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 CallSummaryContext < InstanceContext
             ##
             # Initialize the CallSummaryContext
@@ -107,8 +101,6 @@ module Twilio
             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 CallSummaryInstance < InstanceResource
             ##
             # Initialize the CallSummaryInstance
@@ -126,6 +118,7 @@ module Twilio
                   'call_type' => payload['call_type'],
                   'call_state' => payload['call_state'],
                   'processing_state' => payload['processing_state'],
+                  'created_time' => Twilio.deserialize_iso8601_datetime(payload['created_time']),
                   'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
                   'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
                   'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
@@ -189,6 +182,12 @@ module Twilio
               @properties['processing_state']
             end
 
+            ##
+            # @return [Time] The created_time
+            def created_time
+              @properties['created_time']
+            end
+
             ##
             # @return [Time] The start_time
             def start_time
@@ -250,7 +249,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The tags
+            # @return [Array[String]] The tags
             def tags
               @properties['tags']
             end

data/lib/twilio-ruby/rest/insights/v1/room.rb

@@ -29,8 +29,8 @@ module Twilio
           # Lists RoomInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [room.RoomType] room_type The room_type
-          # @param [room.Codec] codec The codec
+          # @param [Array[room.RoomType]] room_type The room_type
+          # @param [Array[room.Codec]] codec The codec
           # @param [String] room_name The room_name
           # @param [Time] created_after The created_after
           # @param [Time] created_before The created_before
@@ -57,8 +57,8 @@ module Twilio
           # Streams RoomInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [room.RoomType] room_type The room_type
-          # @param [room.Codec] codec The codec
+          # @param [Array[room.RoomType]] room_type The room_type
+          # @param [Array[room.Codec]] codec The codec
           # @param [String] room_name The room_name
           # @param [Time] created_after The created_after
           # @param [Time] created_before The created_before
@@ -101,8 +101,8 @@ module Twilio
           ##
           # Retrieve a single page of RoomInstance records from the API.
           # Request is executed immediately.
-          # @param [room.RoomType] room_type The room_type
-          # @param [room.Codec] codec The codec
+          # @param [Array[room.RoomType]] room_type The room_type
+          # @param [Array[room.Codec]] codec The codec
           # @param [String] room_name The room_name
           # @param [Time] created_after The created_after
           # @param [Time] created_before The created_before
@@ -394,7 +394,7 @@ module Twilio
           end
 
           ##
-          # @return [room.Codec] The codecs
+          # @return [Array[room.Codec]] The codecs
           def codecs
             @properties['codecs']
           end

data/lib/twilio-ruby/rest/insights/v1/room/participant.rb

@@ -297,7 +297,7 @@ module Twilio
             end
 
             ##
-            # @return [participant.Codec] The codecs
+            # @return [Array[participant.Codec]] The codecs
             def codecs
               @properties['codecs']
             end

data/lib/twilio-ruby/rest/ip_messaging/v1/service.rb

@@ -216,7 +216,7 @@ module Twilio
           # @param [String] pre_webhook_url The pre_webhook_url
           # @param [String] post_webhook_url The post_webhook_url
           # @param [String] webhook_method The webhook_method
-          # @param [String] webhook_filters The webhook_filters
+          # @param [Array[String]] webhook_filters The webhook_filters
           # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
           # @param [String] webhooks_on_message_send_method The
           #   webhooks.on_message_send.method
@@ -562,7 +562,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The webhook_filters
+          # @return [Array[String]] The webhook_filters
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -629,7 +629,7 @@ module Twilio
           # @param [String] pre_webhook_url The pre_webhook_url
           # @param [String] post_webhook_url The post_webhook_url
           # @param [String] webhook_method The webhook_method
-          # @param [String] webhook_filters The webhook_filters
+          # @param [Array[String]] webhook_filters The webhook_filters
           # @param [String] webhooks_on_message_send_url The webhooks.on_message_send.url
           # @param [String] webhooks_on_message_send_method The
           #   webhooks.on_message_send.method

data/lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb

@@ -49,7 +49,7 @@ module Twilio
             # Lists ChannelInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The type
             # @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
@@ -65,7 +65,7 @@ module Twilio
             # Streams ChannelInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The type
             # @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
@@ -98,7 +98,7 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [channel.ChannelType] type The type
+            # @param [Array[channel.ChannelType]] type The type
             # @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