twilio-ruby 7.10.5 → 7.10.6

data/lib/twilio-ruby/rest/memory/v1/recall.rb

@@ -0,0 +1,366 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio Memory API
+#    APIs for managing memory stores, profiles, events, and conversational intelligence capabilities.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Memory < MemoryBase
+            class V1 < Version
+                class RecallList < ListResource
+                
+                    class CommunicationContent
+                            # @param [text]: [String] Primary text content (optional).
+                        attr_accessor :text
+                        def initialize(payload)
+                                @text = payload["text"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "text": @text,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CommunicationRecipients
+                            # @param [id]: [String] Participant identifier.
+                            # @param [name]: [String] Participant display name
+                            # @param [type]: [ParticipantType] 
+                            # @param [profile_id]: [String] The canonical profile ID.
+                            # @param [address]: [String] Address of the Participant (e.g., phone number, email address)
+                            # @param [channel]: [String] The channel on which the message originated
+                            # @param [delivery_status]: [String] Delivery status of the Communication to this recipient
+                        attr_accessor :id, :name, :type, :profile_id, :address, :channel, :delivery_status
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @name = payload["name"]
+                                @type = payload["type"]
+                                @profile_id = payload["profile_id"]
+                                @address = payload["address"]
+                                @channel = payload["channel"]
+                                @delivery_status = payload["delivery_status"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "name": @name,
+                                "type": @type,
+                                "profileId": @profile_id,
+                                "address": @address,
+                                "channel": @channel,
+                                "deliveryStatus": @delivery_status,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class MemoryRetrievalRequest
+                            # @param [conversation_id]: [String] A unique identifier for the conversation using Twilio Type ID (TTID) format.
+                            # @param [query]: [String] Hybrid search query for finding relevant memories. Omit to use query expansion to generate query from previous 10 communications in conversation.
+                            # @param [begin_date]: [Time] Start date for filtering memories (inclusive).
+                            # @param [end_date]: [Time] End date for filtering memories (exclusive).
+                            # @param [communications_limit]: [String] Maximum number of conversational session memories to return. If omitted or set to 0, no session memories will be fetched.
+                            # @param [observations_limit]: [String] Maximum number of observation memories to return. If omitted, defaults to 20. If set to 0, no observation memories will be fetched.
+                            # @param [summaries_limit]: [String] Maximum number of summary memories to return. If omitted, defaults to 5. If set to 0, no summary memories will be fetched.
+                            # @param [relevance_threshold]: [Float] Minimum relevance score threshold for observations and summaries to be returned. Only memories with a relevance score greater than or equal to this threshold will be included in the response. This threshold only applies when results are ranked by relevance. When results are returned in most-recent order, this field has no effect.
+                        attr_accessor :conversation_id, :query, :begin_date, :end_date, :communications_limit, :observations_limit, :summaries_limit, :relevance_threshold
+                        def initialize(payload)
+                                @conversation_id = payload["conversation_id"]
+                                @query = payload["query"]
+                                @begin_date = payload["begin_date"]
+                                @end_date = payload["end_date"]
+                                @communications_limit = payload["communications_limit"]
+                                @observations_limit = payload["observations_limit"]
+                                @summaries_limit = payload["summaries_limit"]
+                                @relevance_threshold = payload["relevance_threshold"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "conversationId": @conversation_id,
+                                "query": @query,
+                                "beginDate": @begin_date,
+                                "endDate": @end_date,
+                                "communicationsLimit": @communications_limit,
+                                "observationsLimit": @observations_limit,
+                                "summariesLimit": @summaries_limit,
+                                "relevanceThreshold": @relevance_threshold,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class Participant
+                            # @param [id]: [String] Participant identifier.
+                            # @param [name]: [String] Participant display name
+                            # @param [type]: [ParticipantType] 
+                            # @param [profile_id]: [String] The canonical profile ID.
+                            # @param [address]: [String] Address of the Participant (e.g., phone number, email address)
+                            # @param [channel]: [String] The channel on which the message originated
+                        attr_accessor :id, :name, :type, :profile_id, :address, :channel
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @name = payload["name"]
+                                @type = payload["type"]
+                                @profile_id = payload["profile_id"]
+                                @address = payload["address"]
+                                @channel = payload["channel"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "name": @name,
+                                "type": @type,
+                                "profileId": @profile_id,
+                                "address": @address,
+                                "channel": @channel,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the RecallList
+                    # @param [Version] version Version that contains the resource
+                    # @return [RecallList] RecallList
+                    def initialize(version, store_id: nil, profile_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { store_id: store_id, profile_id: profile_id }
+                        @uri = "/Stores/#{@solution[:store_id]}/Profiles/#{@solution[:profile_id]}/Recall"
+                        
+                    end
+                    ##
+                    # Create the RecallInstance
+                    # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    # @param [String] content_encoding Compression algorithm used for the request body (e.g., gzip, deflate, br)
+                    # @param [MemoryRetrievalRequest] memory_retrieval_request 
+                    # @return [RecallInstance] Created RecallInstance
+                    def create(
+                      accept_encoding: :unset, 
+                      content_encoding: :unset,
+                      memory_retrieval_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Accept-Encoding' => accept_encoding, 'Content-Encoding' => content_encoding, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: memory_retrieval_request.to_json)
+                        RecallInstance.new(
+                            @version,
+                            payload,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                    end
+
+                    ##
+                    # Create the RecallInstanceMetadata
+                    # @param [String] accept_encoding Compression algorithms supported by the client (e.g., gzip, deflate, br)
+                    # @param [String] content_encoding Compression algorithm used for the request body (e.g., gzip, deflate, br)
+                    # @param [MemoryRetrievalRequest] memory_retrieval_request 
+                    # @return [RecallInstance] Created RecallInstance
+                    def create_with_metadata(
+                      accept_encoding: :unset, 
+                      content_encoding: :unset,
+                    memory_retrieval_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Accept-Encoding' => accept_encoding, 'Content-Encoding' => content_encoding, })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: memory_retrieval_request.to_json)
+                        recall_instance = RecallInstance.new(
+                            @version,
+                            response.body,
+                            store_id: @solution[:store_id],
+                            profile_id: @solution[:profile_id],
+                        )
+                        RecallInstanceMetadata.new(
+                            @version,
+                            recall_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Memory.V1.RecallList>'
+                    end
+                end
+
+                class RecallPage < TokenPage
+                    ##
+                    # Initialize the RecallPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [RecallPage] RecallPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of RecallInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [RecallInstance] RecallInstance
+                    def get_instance(payload)
+                        RecallInstance.new(@version, payload, store_id: @solution[:store_id], profile_id: @solution[:profile_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Memory.V1.RecallPage>'
+                    end
+                end
+
+                class RecallPageMetadata < PageMetadata
+                    attr_reader :recall_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @recall_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @recall_page << RecallListResponse.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
+                        @recall_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Memory::V1PageMetadata>';
+                    end
+                end
+                class RecallListResponse < InstanceListResource
+
+                    # @param [Array<RecallInstance>] 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
+                      @recall = data_list.map do |data|
+                        RecallInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def recall
+                        @recall
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class RecallInstance < InstanceResource
+                    ##
+                    # Initialize the RecallInstance
+                    # @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 Recall
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [RecallInstance] RecallInstance
+                    def initialize(version, payload , store_id: nil, profile_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'observations' => payload['observations'],
+                            'summaries' => payload['summaries'],
+                            'communications' => payload['communications'],
+                            'meta' => payload['meta'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Array<RecallObservationInfo>] Array of observation memories.
+                    def observations
+                        @properties['observations']
+                    end
+                    
+                    ##
+                    # @return [Array<RecallSummaryInfo>] Array of summary memories derived from observations at the end of conversations.
+                    def summaries
+                        @properties['summaries']
+                    end
+                    
+                    ##
+                    # @return [Array<Communication>] Array of recent communication context.
+                    def communications
+                        @properties['communications']
+                    end
+                    
+                    ##
+                    # @return [MemoryRetrievalResponseMeta] 
+                    def meta
+                        @properties['meta']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Memory.V1.RecallInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Memory.V1.RecallInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end