twilio-ruby 7.10.4 → 7.10.6

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

@@ -0,0 +1,1365 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Conversation Orchestrator
+#    Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Conversations < ConversationsBase
+            class V2 < Version
+                class ConversationList < ListResource
+                
+                    class ConversationsV2Address
+                            # @param [channel]: [String] The channel for Communication.
+                            # @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 
+                            # @param [channel_id]: [String] Channel-specific ID for correlating Communications.
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2CaptureRule
+                            # @param [from]: [String] The from address. Use `*` for wildcard to match any from address.
+                            # @param [to]: [String] The to address. Use `*` for wildcard to match any to address.
+                            # @param [metadata]: [Hash<String, String>] Additional matching criteria for the capture rule. For voice calls, can include `callType` (`PSTN`, `SIP`, and similar).
+                        attr_accessor :from, :to, :metadata
+                        def initialize(payload)
+                                @from = payload["from"]
+                                @to = payload["to"]
+                                @metadata = payload["metadata"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "from": @from,
+                                "to": @to,
+                                "metadata": @metadata,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2StatusTimeouts
+                            # @param [inactive]: [Integer] Inactivity timeout in minutes.
+                            # @param [closed]: [Integer] Close timeout in minutes.
+                        attr_accessor :inactive, :closed
+                        def initialize(payload)
+                                @inactive = payload["inactive"]
+                                @closed = payload["closed"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "inactive": @inactive,
+                                "closed": @closed,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequest
+                            # @param [configuration_id]: [String] The ID of an existing configuration.
+                            # @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
+                        def initialize(payload)
+                                @configuration_id = payload["configuration_id"]
+                                @name = payload["name"]
+                                @configuration = payload["configuration"]
+                                @participants = payload["participants"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "configurationId": @configuration_id,
+                                "name": @name,
+                                "configuration": @configuration,
+                                "participants": @participants,
+                        }.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
+                        def initialize(payload)
+                                @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipants
+                            # @param [name]: [String] Display name for the Participant.
+                            # @param [type]: [String] Type of Participant in the Conversation.
+                            # @param [profile_id]: [String] Resolved profile ID.
+                            # @param [addresses]: [Array<ConversationList.CreateConversationWithConfigRequestParticipantsAddresses>] List of Communication addresses for the Participant.
+                        attr_accessor :name, :type, :profile_id, :addresses
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @type = payload["type"]
+                                @profile_id = payload["profile_id"]
+                                @addresses = payload["addresses"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "type": @type,
+                                "profileId": @profile_id,
+                                "addresses": @addresses,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipantsAddresses
+                            # @param [channel]: [String] 
+                            # @param [address]: [String] 
+                            # @param [channel_id]: [String] 
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                            # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
+                        attr_accessor :name, :status, :configuration
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                                @configuration = payload["configuration"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                                "configuration": @configuration,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequestConfiguration
+                            # @param [status_callbacks]: [Array<ConversationList.ConversationsV2StatusCallbackConfig>] List of webhook configurations for this conversation. Send an empty array to clear all callbacks and stop webhook delivery.
+                        attr_accessor :status_callbacks
+                        def initialize(payload)
+                                @status_callbacks = payload["status_callbacks"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "statusCallbacks": @status_callbacks,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class UpdateConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                        attr_accessor :name, :status
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class ConversationsV2Address
+                            # @param [channel]: [String] The channel for Communication.
+                            # @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 
+                            # @param [channel_id]: [String] Channel-specific ID for correlating Communications.
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2CaptureRule
+                            # @param [from]: [String] The from address. Use `*` for wildcard to match any from address.
+                            # @param [to]: [String] The to address. Use `*` for wildcard to match any to address.
+                            # @param [metadata]: [Hash<String, String>] Additional matching criteria for the capture rule. For voice calls, can include `callType` (`PSTN`, `SIP`, and similar).
+                        attr_accessor :from, :to, :metadata
+                        def initialize(payload)
+                                @from = payload["from"]
+                                @to = payload["to"]
+                                @metadata = payload["metadata"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "from": @from,
+                                "to": @to,
+                                "metadata": @metadata,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2StatusTimeouts
+                            # @param [inactive]: [Integer] Inactivity timeout in minutes.
+                            # @param [closed]: [Integer] Close timeout in minutes.
+                        attr_accessor :inactive, :closed
+                        def initialize(payload)
+                                @inactive = payload["inactive"]
+                                @closed = payload["closed"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "inactive": @inactive,
+                                "closed": @closed,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequest
+                            # @param [configuration_id]: [String] The ID of an existing configuration.
+                            # @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
+                        def initialize(payload)
+                                @configuration_id = payload["configuration_id"]
+                                @name = payload["name"]
+                                @configuration = payload["configuration"]
+                                @participants = payload["participants"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "configurationId": @configuration_id,
+                                "name": @name,
+                                "configuration": @configuration,
+                                "participants": @participants,
+                        }.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
+                        def initialize(payload)
+                                @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipants
+                            # @param [name]: [String] Display name for the Participant.
+                            # @param [type]: [String] Type of Participant in the Conversation.
+                            # @param [profile_id]: [String] Resolved profile ID.
+                            # @param [addresses]: [Array<ConversationList.CreateConversationWithConfigRequestParticipantsAddresses>] List of Communication addresses for the Participant.
+                        attr_accessor :name, :type, :profile_id, :addresses
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @type = payload["type"]
+                                @profile_id = payload["profile_id"]
+                                @addresses = payload["addresses"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "type": @type,
+                                "profileId": @profile_id,
+                                "addresses": @addresses,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipantsAddresses
+                            # @param [channel]: [String] 
+                            # @param [address]: [String] 
+                            # @param [channel_id]: [String] 
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                            # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
+                        attr_accessor :name, :status, :configuration
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                                @configuration = payload["configuration"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                                "configuration": @configuration,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequestConfiguration
+                            # @param [status_callbacks]: [Array<ConversationList.ConversationsV2StatusCallbackConfig>] List of webhook configurations for this conversation. Send an empty array to clear all callbacks and stop webhook delivery.
+                        attr_accessor :status_callbacks
+                        def initialize(payload)
+                                @status_callbacks = payload["status_callbacks"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "statusCallbacks": @status_callbacks,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class UpdateConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                        attr_accessor :name, :status
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class ConversationsV2Address
+                            # @param [channel]: [String] The channel for Communication.
+                            # @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 
+                            # @param [channel_id]: [String] Channel-specific ID for correlating Communications.
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2CaptureRule
+                            # @param [from]: [String] The from address. Use `*` for wildcard to match any from address.
+                            # @param [to]: [String] The to address. Use `*` for wildcard to match any to address.
+                            # @param [metadata]: [Hash<String, String>] Additional matching criteria for the capture rule. For voice calls, can include `callType` (`PSTN`, `SIP`, and similar).
+                        attr_accessor :from, :to, :metadata
+                        def initialize(payload)
+                                @from = payload["from"]
+                                @to = payload["to"]
+                                @metadata = payload["metadata"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "from": @from,
+                                "to": @to,
+                                "metadata": @metadata,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2StatusTimeouts
+                            # @param [inactive]: [Integer] Inactivity timeout in minutes.
+                            # @param [closed]: [Integer] Close timeout in minutes.
+                        attr_accessor :inactive, :closed
+                        def initialize(payload)
+                                @inactive = payload["inactive"]
+                                @closed = payload["closed"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "inactive": @inactive,
+                                "closed": @closed,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequest
+                            # @param [configuration_id]: [String] The ID of an existing configuration.
+                            # @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
+                        def initialize(payload)
+                                @configuration_id = payload["configuration_id"]
+                                @name = payload["name"]
+                                @configuration = payload["configuration"]
+                                @participants = payload["participants"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "configurationId": @configuration_id,
+                                "name": @name,
+                                "configuration": @configuration,
+                                "participants": @participants,
+                        }.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
+                        def initialize(payload)
+                                @intelligence_configuration_ids = payload["intelligence_configuration_ids"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "intelligenceConfigurationIds": @intelligence_configuration_ids,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipants
+                            # @param [name]: [String] Display name for the Participant.
+                            # @param [type]: [String] Type of Participant in the Conversation.
+                            # @param [profile_id]: [String] Resolved profile ID.
+                            # @param [addresses]: [Array<ConversationList.CreateConversationWithConfigRequestParticipantsAddresses>] List of Communication addresses for the Participant.
+                        attr_accessor :name, :type, :profile_id, :addresses
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @type = payload["type"]
+                                @profile_id = payload["profile_id"]
+                                @addresses = payload["addresses"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "type": @type,
+                                "profileId": @profile_id,
+                                "addresses": @addresses,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationWithConfigRequestParticipantsAddresses
+                            # @param [channel]: [String] 
+                            # @param [address]: [String] 
+                            # @param [channel_id]: [String] 
+                        attr_accessor :channel, :address, :channel_id
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @address = payload["address"]
+                                @channel_id = payload["channel_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "address": @address,
+                                "channelId": @channel_id,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                            # @param [configuration]: [ConversationList.PatchConversationByIdRequestConfiguration] 
+                        attr_accessor :name, :status, :configuration
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                                @configuration = payload["configuration"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                                "configuration": @configuration,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class PatchConversationByIdRequestConfiguration
+                            # @param [status_callbacks]: [Array<ConversationList.ConversationsV2StatusCallbackConfig>] List of webhook configurations for this conversation. Send an empty array to clear all callbacks and stop webhook delivery.
+                        attr_accessor :status_callbacks
+                        def initialize(payload)
+                                @status_callbacks = payload["status_callbacks"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "statusCallbacks": @status_callbacks,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class UpdateConversationByIdRequest
+                            # @param [name]: [String] The name of the Conversation.
+                            # @param [status]: [String] The state of the Conversation.
+                        attr_accessor :name, :status
+                        def initialize(payload)
+                                @name = payload["name"]
+                                @status = payload["status"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "name": @name,
+                                "status": @status,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ConversationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ConversationList] ConversationList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Conversations"
+                        
+                    end
+                    ##
+                    # Create the ConversationInstance
+                    # @param [CreateConversationWithConfigRequest] create_conversation_with_config_request 
+                    # @return [ConversationInstance] Created ConversationInstance
+                    def create(create_conversation_with_config_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: create_conversation_with_config_request.to_json)
+                        ConversationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the ConversationInstanceMetadata
+                    # @param [CreateConversationWithConfigRequest] create_conversation_with_config_request 
+                    # @return [ConversationInstance] Created ConversationInstance
+                    def create_with_metadata(create_conversation_with_config_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: create_conversation_with_config_request.to_json)
+                        conversation_instance = ConversationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ConversationInstanceMetadata.new(
+                            @version,
+                            conversation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists ConversationInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Array[String]] status Filters for specific statuses
+                    # @param [String] channel_id The resource identifier (such as callSid or messageSid) to filter conversations.
+                    # @param [String] page_token A URL-safe, base64-encoded token representing the page of results to return
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(status: :unset, channel_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            status: status,
+                            channel_id: channel_id,
+                            page_token: page_token,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Array[String]] status Filters for specific statuses
+                    # @param [String] channel_id The resource identifier (such as callSid or messageSid) to filter conversations.
+                    # @param [String] page_token A URL-safe, base64-encoded token representing the page of results to return
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(status: :unset, channel_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            status: status,
+                            channel_id: channel_id,
+                            page_token: page_token,
+                            page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists ConversationPageMetadata records from the API as a list.
+                      # @param [Array[String]] status Filters for specific statuses
+                      # @param [String] channel_id The resource identifier (such as callSid or messageSid) to filter conversations.
+                      # @param [String] page_token A URL-safe, base64-encoded token representing the page of results to return
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(status: :unset, channel_id: :unset, page_token: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'status' =>  Twilio.serialize_list(status) { |e| e },
+                            'channelId' => channel_id,
+                            'pageToken' => page_token,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConversationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ConversationInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of ConversationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [Array[String]] status Filters for specific statuses
+                    # @param [String] channel_id The resource identifier (such as callSid or messageSid) to filter conversations.
+                    # @param [String] page_token A URL-safe, base64-encoded token representing the page of results to return
+                    
+                    # @return [Page] Page of ConversationInstance
+                    def page(status: :unset, channel_id: :unset, page_token: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            
+                            'status' =>  Twilio.serialize_list(status) { |e| e },
+                            'channelId' => channel_id,
+                            'pageToken' => page_token,
+                                                        'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ConversationPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ConversationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ConversationInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ConversationPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Conversations.V2.ConversationList>'
+                    end
+                end
+
+
+                class ConversationContext < InstanceContext
+                    ##
+                    # Initialize the ConversationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid 
+                    # @return [ConversationContext] ConversationContext
+                    def initialize(version, sid)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Conversations/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the ConversationInstance
+                    # @param [String] idempotency_key Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete(
+                      idempotency_key: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        
+                        
+                        
+                        response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                        ConversationInstance.new(
+                          @version,
+                          response.body,
+                            sid: @solution[:sid],
+                        )
+                        
+                    end
+
+                    ##
+                    # Delete the ConversationInstanceMetadata
+                    # @param [String] idempotency_key Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      idempotency_key: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Idempotency-Key' => idempotency_key, })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          conversation_instance = ConversationInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ConversationInstanceMetadata.new(@version, conversation_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the ConversationInstance
+                    # @return [ConversationInstance] Fetched ConversationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ConversationInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ConversationInstanceMetadata
+                    # @return [ConversationInstance] Fetched ConversationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        conversation_instance = ConversationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ConversationInstanceMetadata.new(
+                            @version,
+                            conversation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the ConversationInstance
+                    # @param [PatchConversationByIdRequest] patch_conversation_by_id_request The conversation fields to update
+                    # @return [ConversationInstance] Patched ConversationInstance
+                    def patch(patch_conversation_by_id_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.patch('PATCH', @uri, headers: headers, data: patch_conversation_by_id_request.to_json)
+                        ConversationInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Patch the ConversationInstanceMetadata
+                    # @param [PatchConversationByIdRequest] patch_conversation_by_id_request The conversation fields to update
+                    # @return [ConversationInstance] Patchd ConversationInstance
+                    def patch_with_metadata(patch_conversation_by_id_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: patch_conversation_by_id_request.to_json)
+                        conversation_instance = ConversationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ConversationInstanceMetadata.new(
+                            @version,
+                            conversation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the ConversationInstance
+                    # @param [UpdateConversationByIdRequest] update_conversation_by_id_request The conversation to update
+                    # @return [ConversationInstance] Updated ConversationInstance
+                    def update(update_conversation_by_id_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('PUT', @uri, headers: headers, data: update_conversation_by_id_request.to_json)
+                        ConversationInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the ConversationInstanceMetadata
+                    # @param [UpdateConversationByIdRequest] update_conversation_by_id_request The conversation to update
+                    # @return [ConversationInstance] Updated ConversationInstance
+                    def update_with_metadata(update_conversation_by_id_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: update_conversation_by_id_request.to_json)
+                        conversation_instance = ConversationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ConversationInstanceMetadata.new(
+                            @version,
+                            conversation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V2.ConversationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V2.ConversationContext #{context}>"
+                    end
+                end
+
+                class ConversationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ConversationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ConversationInstance] conversation_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ConversationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, conversation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @conversation_instance = conversation_instance
+                    end
+
+                    def conversation
+                        @conversation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ConversationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ConversationListResponse < InstanceListResource
+                    # @param [Array<ConversationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @conversation_instance = payload.body[key].map do |data|
+                        ConversationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def conversation_instance
+                          @instance
+                      end
+                  end
+
+                class ConversationPage < TokenPage
+                    ##
+                    # Initialize the ConversationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ConversationPage] ConversationPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ConversationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ConversationInstance] ConversationInstance
+                    def get_instance(payload)
+                        ConversationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Conversations.V2.ConversationPage>'
+                    end
+                end
+
+                class ConversationPageMetadata < PageMetadata
+                    attr_reader :conversation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @conversation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @conversation_page << ConversationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @conversation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V2PageMetadata>';
+                    end
+                end
+                class ConversationListResponse < InstanceListResource
+
+                    # @param [Array<ConversationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @conversation = data_list.map do |data|
+                        ConversationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def conversation
+                        @conversation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ConversationInstance < InstanceResource
+                    ##
+                    # Initialize the ConversationInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Conversation
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ConversationInstance] ConversationInstance
+                    def initialize(version, payload , sid: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'account_id' => payload['account_id'],
+                            'configuration_id' => payload['configuration_id'],
+                            'status' => payload['status'],
+                            'name' => payload['name'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'configuration' => payload['configuration'],
+                            'participants' => payload['participants'],
+                            'status_url' => payload['status_url'],
+                            'related' => payload['related'],
+                            'display_name' => payload['display_name'],
+                            'description' => payload['description'],
+                            'conversation_grouping_type' => payload['conversation_grouping_type'],
+                            'memory_store_id' => payload['memory_store_id'],
+                            'channel_settings' => payload['channel_settings'],
+                            'status_callbacks' => payload['status_callbacks'],
+                            'intelligence_configuration_ids' => payload['intelligence_configuration_ids'],
+                            'memory_extraction_enabled' => payload['memory_extraction_enabled'],
+                            'conversations_v1_bridge' => payload['conversations_v1_bridge'],
+                            'version' => payload['version'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [ConversationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ConversationContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Conversation ID.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] Account ID.
+                    def account_id
+                        @properties['account_id']
+                    end
+                    
+                    ##
+                    # @return [String] Configuration ID.
+                    def configuration_id
+                        @properties['configuration_id']
+                    end
+                    
+                    ##
+                    # @return [String] Conversation status.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] Conversation name.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when this Conversation was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when this Conversation was last updated.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [ListConversationByAccount200ResponseConversationsConfiguration] 
+                    def configuration
+                        @properties['configuration']
+                    end
+                    
+                    ##
+                    # @return [Array<ConversationsV2Participant>] Participants in this Conversation.
+                    def participants
+                        @properties['participants']
+                    end
+                    
+                    ##
+                    # @return [String] URL to poll for operation status.
+                    def status_url
+                        @properties['status_url']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, String>] Named resource identifiers associated with this operation. Keys depend on the operation type: - config-create, config-update, config-delete: configurationId - conversation-delete: conversationId 
+                    def related
+                        @properties['related']
+                    end
+                    
+                    ##
+                    # @return [String] A human-readable name for the configuration. Limited to 32 characters.
+                    def display_name
+                        @properties['display_name']
+                    end
+                    
+                    ##
+                    # @return [String] Human-readable description for the Configuration. Allows spaces and special characters, typically limited to a paragraph of text. This serves as a descriptive field rather than just a name.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [String] Type of Conversation grouping strategy: - `GROUP_BY_PROFILE`: Groups Communications by resolved Profile from the Memory Store.   A Profile is looked up or created for `CUSTOMER` Participant types. All Communications from the same Profile are in the same Conversation, regardless of address or channel. - `GROUP_BY_PARTICIPANT_ADDRESSES`: Groups Communications by Participant addresses across all channels.   A customer using +18005550100 will be in the same Conversation whether they contact by SMS, WhatsApp, or RCS. - `GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE`: Groups Communications by both Participant addresses AND channel.   A customer using +18005550100 by SMS will be in a different Conversation than the same customer by Voice. 
+                    def conversation_grouping_type
+                        @properties['conversation_grouping_type']
+                    end
+                    
+                    ##
+                    # @return [String] Memory Store ID for Profile resolution.
+                    def memory_store_id
+                        @properties['memory_store_id']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, ConversationsV2ChannelSetting>] Channel-specific configuration settings by channel type. Keys should be valid channel types (`VOICE`, `SMS`, `RCS`, `WHATSAPP`, `CHAT`).
+                    def channel_settings
+                        @properties['channel_settings']
+                    end
+                    
+                    ##
+                    # @return [Array<ConversationsV2StatusCallbackConfig>] List of default webhook configurations applied to Conversations under this Configuration.
+                    def status_callbacks
+                        @properties['status_callbacks']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] A list of Conversational Intelligence configuration IDs.
+                    def intelligence_configuration_ids
+                        @properties['intelligence_configuration_ids']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether memory extraction is enabled for conversations under this configuration. Defaults to false.
+                    def memory_extraction_enabled
+                        @properties['memory_extraction_enabled']
+                    end
+                    
+                    ##
+                    # @return [ConversationsV2ConversationsV1Bridge] 
+                    def conversations_v1_bridge
+                        @properties['conversations_v1_bridge']
+                    end
+                    
+                    ##
+                    # @return [String] Version number used for optimistic locking.
+                    def version
+                        @properties['version']
+                    end
+                    
+                    ##
+                    # Delete the ConversationInstance
+                    # @param [String] idempotency_key Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete(
+                      idempotency_key: :unset
+                    )
+
+                        context.delete(
+                            idempotency_key: idempotency_key, 
+                        )
+                    end
+
+                    ##
+                    # Fetch the ConversationInstance
+                    # @return [ConversationInstance] Fetched ConversationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Patch the ConversationInstance
+                    # @param [PatchConversationByIdRequest] patch_conversation_by_id_request The conversation fields to update
+                    # @return [ConversationInstance] Patched ConversationInstance
+                    def patch(patch_conversation_by_id_request: :unset
+                    )
+
+                        context.patch(
+                            patch_conversation_by_id_request: patch_conversation_by_id_request, 
+                        )
+                    end
+
+                    ##
+                    # Update the ConversationInstance
+                    # @param [UpdateConversationByIdRequest] update_conversation_by_id_request The conversation to update
+                    # @return [ConversationInstance] Updated ConversationInstance
+                    def update(update_conversation_by_id_request: :unset
+                    )
+
+                        context.update(
+                            update_conversation_by_id_request: update_conversation_by_id_request, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V2.ConversationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V2.ConversationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end