twilio-ruby 7.10.4 → 7.10.6

data/lib/twilio-ruby/rest/intelligence/v3/conversation.rb

@@ -0,0 +1,602 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Conversational Intelligence API
+#    The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve processed conversations and operator results.  * Use the Configurations resource to create and manage intelligence configurations and define rules that control how and when language operators analyze and transform conversations.  * Use the Operators resource to create custom language operators or retrieve Twilio-author and custom operators. * Use the Conversations resource to retrieve conversations processed with an intelligence configuration, and the OperatorResults resource to retrieve language operator results for those conversations. 
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Intelligence < IntelligenceBase
+            class V3 < Version
+                class ConversationList < ListResource
+                
+                    ##
+                    # 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
+                
+                    ##
+                    # 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 [String] page_token Token for pagination
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [String] status Filter by Conversation status.
+                    # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
+                    # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
+                    # @param [String] conversation_configuration_id The configuration `id` used to generate the Conversation.
+                    # @param [Array[String]] intelligence_configuration_ids Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (`OR` match).
+                    # @param [Array[String]] operator_ids Filters Conversations to those where at least one of the specified Language Operators was executed (`OR` match).
+                    # @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(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            page_token: page_token,
+                            created_at_before: created_at_before,
+                            created_at_after: created_at_after,
+                            status: status,
+                            channel_id: channel_id,
+                            channels: channels,
+                            conversation_configuration_id: conversation_configuration_id,
+                            intelligence_configuration_ids: intelligence_configuration_ids,
+                            operator_ids: operator_ids,
+                            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 [String] page_token Token for pagination
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [String] status Filter by Conversation status.
+                    # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
+                    # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
+                    # @param [String] conversation_configuration_id The configuration `id` used to generate the Conversation.
+                    # @param [Array[String]] intelligence_configuration_ids Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (`OR` match).
+                    # @param [Array[String]] operator_ids Filters Conversations to those where at least one of the specified Language Operators was executed (`OR` match).
+                    # @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(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_token: page_token,
+                            created_at_before: created_at_before,
+                            created_at_after: created_at_after,
+                            status: status,
+                            channel_id: channel_id,
+                            channels: channels,
+                            conversation_configuration_id: conversation_configuration_id,
+                            intelligence_configuration_ids: intelligence_configuration_ids,
+                            operator_ids: operator_ids,
+                            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 [String] page_token Token for pagination
+                      # @param [Time] created_at_before Filter by Conversations created before this timestamp.
+                      # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                      # @param [String] status Filter by Conversation status.
+                      # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
+                      # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
+                      # @param [String] conversation_configuration_id The configuration `id` used to generate the Conversation.
+                      # @param [Array[String]] intelligence_configuration_ids Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (`OR` match).
+                      # @param [Array[String]] operator_ids Filters Conversations to those where at least one of the specified Language Operators was executed (`OR` match).
+                    # @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(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'createdAtBefore' =>  Twilio.serialize_iso8601_datetime(created_at_before),
+                            'createdAtAfter' =>  Twilio.serialize_iso8601_datetime(created_at_after),
+                            'status' => status,
+                            'channelId' => channel_id,
+                            
+                            'channels' =>  Twilio.serialize_list(channels) { |e| e },
+                            'conversationConfigurationId' => conversation_configuration_id,
+                            
+                            'intelligenceConfigurationIds' =>  Twilio.serialize_list(intelligence_configuration_ids) { |e| e },
+                            
+                            'operatorIds' =>  Twilio.serialize_list(operator_ids) { |e| e },
+                            
+                            '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 [String] page_token Token for pagination
+                    # @param [Time] created_at_before Filter by Conversations created before this timestamp.
+                    # @param [Time] created_at_after Filter by Conversations created after this timestamp.
+                    # @param [String] status Filter by Conversation status.
+                    # @param [String] channel_id Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.
+                    # @param [Array[String]] channels Filters Conversations that include one or more of the specified communication channels (`OR` match).
+                    # @param [String] conversation_configuration_id The configuration `id` used to generate the Conversation.
+                    # @param [Array[String]] intelligence_configuration_ids Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (`OR` match).
+                    # @param [Array[String]] operator_ids Filters Conversations to those where at least one of the specified Language Operators was executed (`OR` match).
+                    
+                    # @return [Page] Page of ConversationInstance
+                    def page(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'pageToken' => page_token,
+                            'createdAtBefore' =>  Twilio.serialize_iso8601_datetime(created_at_before),
+                            'createdAtAfter' =>  Twilio.serialize_iso8601_datetime(created_at_after),
+                            'status' => status,
+                            'channelId' => channel_id,
+                            
+                            'channels' =>  Twilio.serialize_list(channels) { |e| e },
+                            'conversationConfigurationId' => conversation_configuration_id,
+                            
+                            'intelligenceConfigurationIds' =>  Twilio.serialize_list(intelligence_configuration_ids) { |e| e },
+                            
+                            'operatorIds' =>  Twilio.serialize_list(operator_ids) { |e| e },
+                                                        '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.Intelligence.V3.ConversationList>'
+                    end
+                end
+
+
+                class ConversationContext < InstanceContext
+                    ##
+                    # Initialize the ConversationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id The unique identifier of the conversation.
+                    # @return [ConversationContext] ConversationContext
+                    def initialize(version, id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { id: id,  }
+                        @uri = "/Conversations/#{@solution[:id]}"
+
+                        
+                    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,
+                            id: @solution[:id],
+                        )
+                    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,
+                            id: @solution[:id],
+                        )
+                        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.Intelligence.V3.ConversationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Intelligence.V3.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.Intelligence.V3.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::Intelligence::V3PageMetadata>';
+                    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 , id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'account_id' => payload['account_id'],
+                            'name' => payload['name'],
+                            'status' => payload['status'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'intelligence_configuration_ids' => payload['intelligence_configuration_ids'],
+                            'conversation_configuration_id' => payload['conversation_configuration_id'],
+                            'channels' => payload['channels'],
+                            'channel_ids' => payload['channel_ids'],
+                            'participants' => payload['participants'],
+                            'communications' => payload['communications'],
+                            'operator_result_ids' => payload['operator_result_ids'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id' => id  || @properties['id']  , }
+                    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['id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The `id` of the Conversation attached to the Operator Result.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The ID of the account that owns the Conversation.
+                    def account_id
+                        @properties['account_id']
+                    end
+                    
+                    ##
+                    # @return [String] Display name of the Conversation.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [ConversationStatus] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp for when the Conversation was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp for when the Conversation was last updated.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The Intelligence Configuration(s) associated with the Conversation.
+                    def intelligence_configuration_ids
+                        @properties['intelligence_configuration_ids']
+                    end
+                    
+                    ##
+                    # @return [String] The `id` of the Configuration for a Conversation.
+                    def conversation_configuration_id
+                        @properties['conversation_configuration_id']
+                    end
+                    
+                    ##
+                    # @return [Array<Channel>] The communication channel(s) included in the Conversation.
+                    def channels
+                        @properties['channels']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The underlying channel resource `id`s associated with this Conversation, such as a Call ID or Message ID.
+                    def channel_ids
+                        @properties['channel_ids']
+                    end
+                    
+                    ##
+                    # @return [Array<Participant>] Metadata for Participants of the Conversation.
+                    def participants
+                        @properties['participants']
+                    end
+                    
+                    ##
+                    # @return [Array<Communication>] Metadata for the Communications that make up the Conversation.
+                    def communications
+                        @properties['communications']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] List of Operator Result IDs generated from this Conversation.
+                    def operator_result_ids
+                        @properties['operator_result_ids']
+                    end
+                    
+                    ##
+                    # Fetch the ConversationInstance
+                    # @return [ConversationInstance] Fetched ConversationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.ConversationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Intelligence.V3.ConversationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end