twilio-ruby 7.11.2 → 7.12.0

data/lib/twilio-ruby/rest/conversations/v2/conversation.rb

@@ -19,6 +19,19 @@ module Twilio
             class V2 < Version
                 class ConversationList < ListResource
                 
+                    class ConversationWorkflow
+                            # @param [flow_id]: [String] The Studio Flow to run.
+                        attr_accessor :flow_id
+                        def initialize(payload)
+                                @flow_id = payload["flow_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "flowId": @flow_id,
+                        }.to_json(options)
+                        end
+                    end
+
                     class ConversationsV2Address
                             # @param [channel]: [ConversationsV2Channel] 
                             # @param [address]: [String] The address value formatted according to channel type: - SMS/VOICE: E.164 phone number (such as \"+18005550100\") - WHATSAPP: Phone number with whatsapp prefix (such as \"whatsapp:+18005550100\") - RCS: Sender ID or phone number with rcs prefix (such as \"rcs:brand_acme_agent\" or \"rcs:+18005550100\") - CHAT: Customer-defined string identifier 
@@ -78,12 +91,14 @@ module Twilio
                             # @param [name]: [String] The name of the conversation.
                             # @param [configuration]: [ConversationList.CreateConversationWithConfigRequestConfiguration] 
                             # @param [participants]: [Array<ConversationList.CreateConversationWithConfigRequestParticipants>] Optional list of Participants to create with the Conversation.
-                        attr_accessor :configuration_id, :name, :configuration, :participants
+                            # @param [metadata]: [Hash<String, String>] Optional customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :configuration_id, :name, :configuration, :participants, :metadata
                         def initialize(payload)
                                 @configuration_id = payload["configuration_id"]
                                 @name = payload["name"]
                                 @configuration = payload["configuration"]
                                 @participants = payload["participants"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
@@ -91,19 +106,29 @@ module Twilio
                                 "name": @name,
                                 "configuration": @configuration,
                                 "participants": @participants,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
 
                     class CreateConversationWithConfigRequestConfiguration
                             # @param [intelligence_configuration_ids]: [Array<String>] A list of Conversational Intelligence configuration IDs.
-                        attr_accessor :intelligence_configuration_ids
+                            # @param [trait_extraction_strategy_ids]: [Array<String>] A list of Trait Extraction Strategy IDs.
+                            # @param [observation_extraction_strategy_ids]: [Array<String>] A list of Observation Extraction Strategy IDs.
+                            # @param [workflows]: [Array<ConversationList.ConversationWorkflow>] The Workflows to associate with this Conversation. Overrides the Configuration's own.
+                        attr_accessor :intelligence_configuration_ids, :trait_extraction_strategy_ids, :observation_extraction_strategy_ids, :workflows
                         def initialize(payload)
                                 @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                                @trait_extraction_strategy_ids = payload["trait_extraction_strategy_ids"]
+                                @observation_extraction_strategy_ids = payload["observation_extraction_strategy_ids"]
+                                @workflows = payload["workflows"]
                         end
                         def to_json(options = {})
                         {
                                 "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                                "traitExtractionStrategyIds": @trait_extraction_strategy_ids,
+                                "observationExtractionStrategyIds": @observation_extraction_strategy_ids,
+                                "workflows": @workflows,
                         }.to_json(options)
                         end
                     end
@@ -153,17 +178,20 @@ module Twilio
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
                             # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
-                        attr_accessor :name, :status, :configuration
+                            # @param [metadata]: [Hash<String, String>] Merge patch for customer-managed metadata (max 8 entries after merge). Provided keys are added or updated; keys set to null are removed; keys not mentioned are preserved.
+                        attr_accessor :name, :status, :configuration, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
                                 @configuration = payload["configuration"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
                                 "configuration": @configuration,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
@@ -184,20 +212,36 @@ module Twilio
                     class UpdateConversationByIdRequest
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
-                        attr_accessor :name, :status
+                            # @param [metadata]: [Hash<String, String>] Customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :name, :status, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
 
 
+                    class ConversationWorkflow
+                            # @param [flow_id]: [String] The Studio Flow to run.
+                        attr_accessor :flow_id
+                        def initialize(payload)
+                                @flow_id = payload["flow_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "flowId": @flow_id,
+                        }.to_json(options)
+                        end
+                    end
+
                     class ConversationsV2Address
                             # @param [channel]: [ConversationsV2Channel] 
                             # @param [address]: [String] The address value formatted according to channel type: - SMS/VOICE: E.164 phone number (such as \"+18005550100\") - WHATSAPP: Phone number with whatsapp prefix (such as \"whatsapp:+18005550100\") - RCS: Sender ID or phone number with rcs prefix (such as \"rcs:brand_acme_agent\" or \"rcs:+18005550100\") - CHAT: Customer-defined string identifier 
@@ -257,12 +301,14 @@ module Twilio
                             # @param [name]: [String] The name of the conversation.
                             # @param [configuration]: [ConversationList.CreateConversationWithConfigRequestConfiguration] 
                             # @param [participants]: [Array<ConversationList.CreateConversationWithConfigRequestParticipants>] Optional list of Participants to create with the Conversation.
-                        attr_accessor :configuration_id, :name, :configuration, :participants
+                            # @param [metadata]: [Hash<String, String>] Optional customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :configuration_id, :name, :configuration, :participants, :metadata
                         def initialize(payload)
                                 @configuration_id = payload["configuration_id"]
                                 @name = payload["name"]
                                 @configuration = payload["configuration"]
                                 @participants = payload["participants"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
@@ -270,19 +316,29 @@ module Twilio
                                 "name": @name,
                                 "configuration": @configuration,
                                 "participants": @participants,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
 
                     class CreateConversationWithConfigRequestConfiguration
                             # @param [intelligence_configuration_ids]: [Array<String>] A list of Conversational Intelligence configuration IDs.
-                        attr_accessor :intelligence_configuration_ids
+                            # @param [trait_extraction_strategy_ids]: [Array<String>] A list of Trait Extraction Strategy IDs.
+                            # @param [observation_extraction_strategy_ids]: [Array<String>] A list of Observation Extraction Strategy IDs.
+                            # @param [workflows]: [Array<ConversationList.ConversationWorkflow>] The Workflows to associate with this Conversation. Overrides the Configuration's own.
+                        attr_accessor :intelligence_configuration_ids, :trait_extraction_strategy_ids, :observation_extraction_strategy_ids, :workflows
                         def initialize(payload)
                                 @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                                @trait_extraction_strategy_ids = payload["trait_extraction_strategy_ids"]
+                                @observation_extraction_strategy_ids = payload["observation_extraction_strategy_ids"]
+                                @workflows = payload["workflows"]
                         end
                         def to_json(options = {})
                         {
                                 "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                                "traitExtractionStrategyIds": @trait_extraction_strategy_ids,
+                                "observationExtractionStrategyIds": @observation_extraction_strategy_ids,
+                                "workflows": @workflows,
                         }.to_json(options)
                         end
                     end
@@ -332,17 +388,20 @@ module Twilio
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
                             # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
-                        attr_accessor :name, :status, :configuration
+                            # @param [metadata]: [Hash<String, String>] Merge patch for customer-managed metadata (max 8 entries after merge). Provided keys are added or updated; keys set to null are removed; keys not mentioned are preserved.
+                        attr_accessor :name, :status, :configuration, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
                                 @configuration = payload["configuration"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
                                 "configuration": @configuration,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
@@ -363,20 +422,36 @@ module Twilio
                     class UpdateConversationByIdRequest
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
-                        attr_accessor :name, :status
+                            # @param [metadata]: [Hash<String, String>] Customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :name, :status, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
 
 
+                    class ConversationWorkflow
+                            # @param [flow_id]: [String] The Studio Flow to run.
+                        attr_accessor :flow_id
+                        def initialize(payload)
+                                @flow_id = payload["flow_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "flowId": @flow_id,
+                        }.to_json(options)
+                        end
+                    end
+
                     class ConversationsV2Address
                             # @param [channel]: [ConversationsV2Channel] 
                             # @param [address]: [String] The address value formatted according to channel type: - SMS/VOICE: E.164 phone number (such as \"+18005550100\") - WHATSAPP: Phone number with whatsapp prefix (such as \"whatsapp:+18005550100\") - RCS: Sender ID or phone number with rcs prefix (such as \"rcs:brand_acme_agent\" or \"rcs:+18005550100\") - CHAT: Customer-defined string identifier 
@@ -436,12 +511,14 @@ module Twilio
                             # @param [name]: [String] The name of the conversation.
                             # @param [configuration]: [ConversationList.CreateConversationWithConfigRequestConfiguration] 
                             # @param [participants]: [Array<ConversationList.CreateConversationWithConfigRequestParticipants>] Optional list of Participants to create with the Conversation.
-                        attr_accessor :configuration_id, :name, :configuration, :participants
+                            # @param [metadata]: [Hash<String, String>] Optional customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :configuration_id, :name, :configuration, :participants, :metadata
                         def initialize(payload)
                                 @configuration_id = payload["configuration_id"]
                                 @name = payload["name"]
                                 @configuration = payload["configuration"]
                                 @participants = payload["participants"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
@@ -449,19 +526,29 @@ module Twilio
                                 "name": @name,
                                 "configuration": @configuration,
                                 "participants": @participants,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
 
                     class CreateConversationWithConfigRequestConfiguration
                             # @param [intelligence_configuration_ids]: [Array<String>] A list of Conversational Intelligence configuration IDs.
-                        attr_accessor :intelligence_configuration_ids
+                            # @param [trait_extraction_strategy_ids]: [Array<String>] A list of Trait Extraction Strategy IDs.
+                            # @param [observation_extraction_strategy_ids]: [Array<String>] A list of Observation Extraction Strategy IDs.
+                            # @param [workflows]: [Array<ConversationList.ConversationWorkflow>] The Workflows to associate with this Conversation. Overrides the Configuration's own.
+                        attr_accessor :intelligence_configuration_ids, :trait_extraction_strategy_ids, :observation_extraction_strategy_ids, :workflows
                         def initialize(payload)
                                 @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                                @trait_extraction_strategy_ids = payload["trait_extraction_strategy_ids"]
+                                @observation_extraction_strategy_ids = payload["observation_extraction_strategy_ids"]
+                                @workflows = payload["workflows"]
                         end
                         def to_json(options = {})
                         {
                                 "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                                "traitExtractionStrategyIds": @trait_extraction_strategy_ids,
+                                "observationExtractionStrategyIds": @observation_extraction_strategy_ids,
+                                "workflows": @workflows,
                         }.to_json(options)
                         end
                     end
@@ -511,17 +598,20 @@ module Twilio
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
                             # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
-                        attr_accessor :name, :status, :configuration
+                            # @param [metadata]: [Hash<String, String>] Merge patch for customer-managed metadata (max 8 entries after merge). Provided keys are added or updated; keys set to null are removed; keys not mentioned are preserved.
+                        attr_accessor :name, :status, :configuration, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
                                 @configuration = payload["configuration"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
                                 "configuration": @configuration,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
@@ -542,15 +632,18 @@ module Twilio
                     class UpdateConversationByIdRequest
                             # @param [name]: [String] The name of the Conversation.
                             # @param [status]: [String] Lifecycle status of a Conversation.
-                        attr_accessor :name, :status
+                            # @param [metadata]: [Hash<String, String>] Customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                        attr_accessor :name, :status, :metadata
                         def initialize(payload)
                                 @name = payload["name"]
                                 @status = payload["status"]
+                                @metadata = payload["metadata"]
                         end
                         def to_json(options = {})
                         {
                                 "name": @name,
                                 "status": @status,
+                                "metadata": @metadata,
                         }.to_json(options)
                         end
                     end
@@ -1142,7 +1235,9 @@ module Twilio
                             'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
                             'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
                             'configuration' => payload['configuration'],
+                            'metadata' => payload['metadata'],
                             'participants' => payload['participants'],
+                            'action_id' => payload['action_id'],
                             'status_url' => payload['status_url'],
                             'related' => payload['related'],
                             'display_name' => payload['display_name'],
@@ -1152,6 +1247,8 @@ module Twilio
                             'channel_settings' => payload['channel_settings'],
                             'status_callbacks' => payload['status_callbacks'],
                             'intelligence_configuration_ids' => payload['intelligence_configuration_ids'],
+                            'trait_extraction_strategy_ids' => payload['trait_extraction_strategy_ids'],
+                            'observation_extraction_strategy_ids' => payload['observation_extraction_strategy_ids'],
                             'memory_extraction_enabled' => payload['memory_extraction_enabled'],
                             'conversations_v1_bridge' => payload['conversations_v1_bridge'],
                             'version' => payload['version'],
@@ -1221,12 +1318,24 @@ module Twilio
                         @properties['configuration']
                     end
                     
+                    ##
+                    # @return [Hash<String, String>] Customer-managed key-value pairs. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.
+                    def metadata
+                        @properties['metadata']
+                    end
+                    
                     ##
                     # @return [Array<ConversationsV2Participant>] Participants in this Conversation.
                     def participants
                         @properties['participants']
                     end
                     
+                    ##
+                    # @return [String] The Action created for the request's `action`, present only on the create response that dispatched one. Poll `GET /v2/Conversations/{ConversationId}/Actions/{ActionId}` for its status. 
+                    def action_id
+                        @properties['action_id']
+                    end
+                    
                     ##
                     # @return [String] URL to poll for operation status.
                     def status_url
@@ -1281,6 +1390,18 @@ module Twilio
                         @properties['intelligence_configuration_ids']
                     end
                     
+                    ##
+                    # @return [Array<String>] A list of Trait Extraction Strategy IDs.
+                    def trait_extraction_strategy_ids
+                        @properties['trait_extraction_strategy_ids']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] A list of Observation Extraction Strategy IDs.
+                    def observation_extraction_strategy_ids
+                        @properties['observation_extraction_strategy_ids']
+                    end
+                    
                     ##
                     # @return [Boolean] Whether memory extraction is enabled for conversations under this configuration. Defaults to false.
                     def memory_extraction_enabled

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

@@ -369,7 +369,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Array<String>] Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
+                    # @return [Array<String>] [Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags) that Voice Insights analysis applies to calls. They indicate a condition that may influence the subjective experience of call audio quality.
                     def tags
                         @properties['tags']
                     end

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

@@ -681,7 +681,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Array<String>] Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
+                    # @return [Array<String>] [Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags) that Voice Insights analysis applies to calls. They indicate a condition that may influence the subjective experience of call audio quality.
                     def tags
                         @properties['tags']
                     end