twilio-ruby 5.44.0 → 5.47.0

data/lib/twilio-ruby/rest/conversations/v1/service/binding.rb

@@ -31,12 +31,12 @@ module Twilio
             # Lists BindingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [String] identity The identity of a {Conversation
+            # @param [Array[String]] identity The identity of a {Conversation
             #   User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding
             #   belongs to. See {access
             #   tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more
@@ -61,12 +61,12 @@ module Twilio
             # Streams BindingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [String] identity The identity of a {Conversation
+            # @param [Array[String]] identity The identity of a {Conversation
             #   User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding
             #   belongs to. See {access
             #   tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more
@@ -103,12 +103,12 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [String] identity The identity of a {Conversation
+            # @param [Array[String]] identity The identity of a {Conversation
             #   User}[https://www.twilio.com/docs/conversations/api/user-resource] this binding
             #   belongs to. See {access
             #   tokens}[https://www.twilio.com/docs/conversations/create-tokens] for more
@@ -334,7 +334,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The Conversation message types the binding is subscribed to.
+            # @return [Array[String]] The Conversation message types the binding is subscribed to.
             def message_types
               @properties['message_types']
             end

data/lib/twilio-ruby/rest/conversations/v1/service/configuration.rb

@@ -103,12 +103,16 @@ module Twilio
             #   users when they are added to the service. See the {Conversation
             #   Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info
             #   about roles.
+            # @param [Boolean] reachability_enabled Whether the {Reachability
+            #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] is enabled
+            #   for this Conversations Service. The default is `false`.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
-            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)
+            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset)
               data = Twilio::Values.of({
                   'DefaultConversationCreatorRoleSid' => default_conversation_creator_role_sid,
                   'DefaultConversationRoleSid' => default_conversation_role_sid,
                   'DefaultChatServiceRoleSid' => default_chat_service_role_sid,
+                  'ReachabilityEnabled' => reachability_enabled,
               })
 
               payload = @version.update('POST', @uri, data: data)
@@ -157,6 +161,7 @@ module Twilio
                   'default_chat_service_role_sid' => payload['default_chat_service_role_sid'],
                   'url' => payload['url'],
                   'links' => payload['links'],
+                  'reachability_enabled' => payload['reachability_enabled'],
               }
 
               # Context
@@ -211,6 +216,12 @@ module Twilio
               @properties['links']
             end
 
+            ##
+            # @return [Boolean] Whether the Reachability Indicator feature is enabled for this Conversations Service
+            def reachability_enabled
+              @properties['reachability_enabled']
+            end
+
             ##
             # Fetch the ConfigurationInstance
             # @return [ConfigurationInstance] Fetched ConfigurationInstance
@@ -233,12 +244,16 @@ module Twilio
             #   users when they are added to the service. See the {Conversation
             #   Role}[https://www.twilio.com/docs/conversations/api/role-resource] for more info
             #   about roles.
+            # @param [Boolean] reachability_enabled Whether the {Reachability
+            #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] is enabled
+            #   for this Conversations Service. The default is `false`.
             # @return [ConfigurationInstance] Updated ConfigurationInstance
-            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset)
+            def update(default_conversation_creator_role_sid: :unset, default_conversation_role_sid: :unset, default_chat_service_role_sid: :unset, reachability_enabled: :unset)
               context.update(
                   default_conversation_creator_role_sid: default_conversation_creator_role_sid,
                   default_conversation_role_sid: default_conversation_role_sid,
                   default_chat_service_role_sid: default_chat_service_role_sid,
+                  reachability_enabled: reachability_enabled,
               )
             end
 

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb

@@ -423,7 +423,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] An array of objects that describe the Message's media if attached, otherwise, null.
+              # @return [Array[Hash]] An array of objects that describe the Message's media if attached, otherwise, null.
               def media
                 @properties['media']
               end

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb

@@ -247,10 +247,16 @@ module Twilio
               #   number that the participant is in contact with. 'null' value will remove it.
               # @param [String] messaging_binding_projected_address The address of the Twilio
               #   phone number that is used in Group MMS. 'null' value will remove it.
+              # @param [String] last_read_message_index Index of last “read” message in the
+              #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+              #   for the Participant.
+              # @param [String] last_read_timestamp Timestamp of last “read” message in the
+              #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+              #   for the Participant.
               # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
               #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, x_twilio_webhook_enabled: :unset)
+              def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset)
                 data = Twilio::Values.of({
                     'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                     'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
@@ -259,6 +265,8 @@ module Twilio
                     'RoleSid' => role_sid,
                     'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
                     'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
+                    'LastReadMessageIndex' => last_read_message_index,
+                    'LastReadTimestamp' => last_read_timestamp,
                 })
                 headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -344,6 +352,8 @@ module Twilio
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                     'url' => payload['url'],
+                    'last_read_message_index' => payload['last_read_message_index'] == nil ? payload['last_read_message_index'] : payload['last_read_message_index'].to_i,
+                    'last_read_timestamp' => payload['last_read_timestamp'],
                 }
 
                 # Context
@@ -437,6 +447,18 @@ module Twilio
                 @properties['url']
               end
 
+              ##
+              # @return [String] Index of last “read” message in the Conversation for the Participant.
+              def last_read_message_index
+                @properties['last_read_message_index']
+              end
+
+              ##
+              # @return [String] Timestamp of last “read” message in the Conversation for the Participant.
+              def last_read_timestamp
+                @properties['last_read_timestamp']
+              end
+
               ##
               # Update the ParticipantInstance
               # @param [Time] date_created The date that this resource was created.
@@ -457,10 +479,16 @@ module Twilio
               #   number that the participant is in contact with. 'null' value will remove it.
               # @param [String] messaging_binding_projected_address The address of the Twilio
               #   phone number that is used in Group MMS. 'null' value will remove it.
+              # @param [String] last_read_message_index Index of last “read” message in the
+              #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+              #   for the Participant.
+              # @param [String] last_read_timestamp Timestamp of last “read” message in the
+              #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+              #   for the Participant.
               # @param [participant.WebhookEnabledType] x_twilio_webhook_enabled The
               #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [ParticipantInstance] Updated ParticipantInstance
-              def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, x_twilio_webhook_enabled: :unset)
+              def update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset)
                 context.update(
                     date_created: date_created,
                     date_updated: date_updated,
@@ -469,6 +497,8 @@ module Twilio
                     role_sid: role_sid,
                     messaging_binding_proxy_address: messaging_binding_proxy_address,
                     messaging_binding_projected_address: messaging_binding_projected_address,
+                    last_read_message_index: last_read_message_index,
+                    last_read_timestamp: last_read_timestamp,
                     x_twilio_webhook_enabled: x_twilio_webhook_enabled,
                 )
               end

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb

@@ -39,10 +39,10 @@ module Twilio
               #   sent to.
               # @param [webhook.Method] configuration_method The HTTP method to be used when
               #   sending a webhook request.
-              # @param [String] configuration_filters The list of events, firing webhook event
-              #   for this Conversation.
-              # @param [String] configuration_triggers The list of keywords, firing webhook
+              # @param [Array[String]] configuration_filters The list of events, firing webhook
               #   event for this Conversation.
+              # @param [Array[String]] configuration_triggers The list of keywords, firing
+              #   webhook event for this Conversation.
               # @param [String] configuration_flow_sid The studio flow SID, where the webhook
               #   should be sent to.
               # @param [String] configuration_replay_after The message index for which and it's
@@ -217,10 +217,10 @@ module Twilio
               #   sent to.
               # @param [webhook.Method] configuration_method The HTTP method to be used when
               #   sending a webhook request.
-              # @param [String] configuration_filters The list of events, firing webhook event
-              #   for this Conversation.
-              # @param [String] configuration_triggers The list of keywords, firing webhook
+              # @param [Array[String]] configuration_filters The list of events, firing webhook
               #   event for this Conversation.
+              # @param [Array[String]] configuration_triggers The list of keywords, firing
+              #   webhook event for this Conversation.
               # @param [String] configuration_flow_sid The studio flow SID, where the webhook
               #   should be sent to.
               # @return [WebhookInstance] Updated WebhookInstance
@@ -396,10 +396,10 @@ module Twilio
               #   sent to.
               # @param [webhook.Method] configuration_method The HTTP method to be used when
               #   sending a webhook request.
-              # @param [String] configuration_filters The list of events, firing webhook event
-              #   for this Conversation.
-              # @param [String] configuration_triggers The list of keywords, firing webhook
+              # @param [Array[String]] configuration_filters The list of events, firing webhook
               #   event for this Conversation.
+              # @param [Array[String]] configuration_triggers The list of keywords, firing
+              #   webhook event for this Conversation.
               # @param [String] configuration_flow_sid The studio flow SID, where the webhook
               #   should be sent to.
               # @return [WebhookInstance] Updated WebhookInstance

data/lib/twilio-ruby/rest/conversations/v1/service/role.rb

@@ -35,10 +35,10 @@ module Twilio
             #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
             #   roles or `service` for {Conversation
             #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] roles.
-            # @param [String] permission A permission that you grant to the new role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
-            #   repeat this parameter for each permission value. The values for this parameter
-            #   depend on the role's `type`.
+            # @param [Array[String]] permission A permission that you grant to the new role.
+            #   Only one permission can be granted per parameter. To assign more than one
+            #   permission, repeat this parameter for each permission value. The values for this
+            #   parameter depend on the role's `type`.
             # @return [RoleInstance] Created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -187,8 +187,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. Note that the update action
             #   replaces all previously assigned permissions with those defined in the update
             #   action. To remove a permission, do not include it in the subsequent update
@@ -316,7 +316,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of the permissions the role has been granted
+            # @return [Array[String]] An array of the permissions the role has been granted
             def permissions
               @properties['permissions']
             end
@@ -341,8 +341,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. Note that the update action
             #   replaces all previously assigned permissions with those defined in the update
             #   action. To remove a permission, do not include it in the subsequent update

data/lib/twilio-ruby/rest/conversations/v1/service/user.rb

@@ -285,6 +285,7 @@ module Twilio
                   'friendly_name' => payload['friendly_name'],
                   'attributes' => payload['attributes'],
                   'is_online' => payload['is_online'],
+                  'is_notifiable' => payload['is_notifiable'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
@@ -349,11 +350,17 @@ module Twilio
             end
 
             ##
-            # @return [Boolean] Whether the User is actively connected to the Service instance and online
+            # @return [Boolean] Whether the User is actively connected to this Conversations Service and online
             def is_online
               @properties['is_online']
             end
 
+            ##
+            # @return [Boolean] Whether the User has a potentially valid Push Notification registration for this Conversations Service
+            def is_notifiable
+              @properties['is_notifiable']
+            end
+
             ##
             # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created

data/lib/twilio-ruby/rest/conversations/v1/user.rb

@@ -265,6 +265,7 @@ module Twilio
                 'friendly_name' => payload['friendly_name'],
                 'attributes' => payload['attributes'],
                 'is_online' => payload['is_online'],
+                'is_notifiable' => payload['is_notifiable'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -329,11 +330,17 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Whether the User is actively connected to the Service instance and online
+          # @return [Boolean] Whether the User is actively connected to this Conversations Service and online
           def is_online
             @properties['is_online']
           end
 
+          ##
+          # @return [Boolean] Whether the User has a potentially valid Push Notification registration for this Conversations Service
+          def is_notifiable
+            @properties['is_notifiable']
+          end
+
           ##
           # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created

data/lib/twilio-ruby/rest/events/v1/sink.rb

@@ -27,10 +27,12 @@ module Twilio
 
           ##
           # Create the SinkInstance
-          # @param [String] description A human readable description for the Sink
+          # @param [String] description A human readable description for the Sink **This
+          #   value should not contain PII.**
           # @param [Hash] sink_configuration The information required for Twilio to connect
           #   to the provided Sink encoded as JSON.
-          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" currently.
+          # @param [sink.SinkType] sink_type The Sink type. Can only be "kinesis" or
+          #   "webhook" currently.
           # @return [SinkInstance] Created SinkInstance
           def create(description: nil, sink_configuration: nil, sink_type: nil)
             data = Twilio::Values.of({

data/lib/twilio-ruby/rest/events/v1/subscription.rb

@@ -115,11 +115,12 @@ module Twilio
           ##
           # Create the SubscriptionInstance
           # @param [String] description A human readable description for the Subscription
+          #   **This value should not contain PII.**
           # @param [String] sink_sid The SID of the sink that events selected by this
           #   subscription should be sent to. Sink must be active for the subscription to be
           #   created.
-          # @param [Hash] types Contains a dictionary of URL links to nested resources of
-          #   this Subscription.
+          # @param [Array[Hash]] types Contains a dictionary of URL links to nested
+          #   resources of this Subscription.
           # @return [SubscriptionInstance] Created SubscriptionInstance
           def create(description: nil, sink_sid: nil, types: nil)
             data = Twilio::Values.of({

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

@@ -44,7 +44,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that we created to identify the FlexFlow
+      # @param [String] sid The unique string that we created to identify the Flex Flow
       #   resource.
       # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
       # @return [Twilio::REST::Flex_api::V1::FlexFlowList]

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

@@ -42,7 +42,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The SID of the FlexFlow resource to fetch.
+        # @param [String] sid The SID of the Flex Flow resource to fetch.
         # @return [Twilio::REST::Flex_api::V1::FlexFlowContext] if sid was passed.
         # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
         def flex_flow(sid=:unset)

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,6 +164,8 @@ 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'],
             }
 
@@ -232,13 +234,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 +378,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 +390,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,6 +401,18 @@ 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