memori-client 0.1.1 → 0.1.6

data/lib/memori_client/engine/v2/search.rb

@@ -1,40 +1,72 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::Search < MemoriClient::Engine::Resource
-    # POST /memori/v2/Search/{strSessionID}
+    # `POST /memori/v2/Search/{strSessionID}`
+    #
     # Searches for matching Memory objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.text . optional
-    # @param [string] payload.searchType . optional
-    # @param [string] payload.date . optional
-    # @param [number] payload.dateUncertaintyDays . optional
-    # @param [string] payload.placeName . optional
-    # @param [number] payload.placeLatitude . optional
-    # @param [number] payload.placeLongitude . optional
-    # @param [number] payload.placeUncertaintyKm . optional
-    # @param [string] payload.tag . optional
-    # @param [boolean] payload.ignoreLastRead . optional
-    # @param [array] payload.excludedMemoryIDs . optional
-    # @param [object] payload.contextVars . optional
-    # @param [integer] payload.numberOfResults . optional
-    # search_memories(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.text . optional
+    #
+    # @param [String] payload.searchType . optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # @param [Number] payload.dateUncertaintyDays . optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.placeLatitude . optional
+    #
+    # @param [Number] payload.placeLongitude . optional
+    #
+    # @param [Number] payload.placeUncertaintyKm . optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # @param [Boolean] payload.ignoreLastRead . optional
+    #
+    # @param [Array] payload.excludedMemoryIDs . optional
+    #
+    # @param [Object] payload.contextVars . optional
+    #
+    # @param [Object] payload.contextVarsToSet . optional
+    #
+    # @param [Array] payload.memoryTags . optional
+    #
+    # @param [Integer] payload.numberOfResults . optional
+    #
+    # @param [Integer] payload.startFrom . optional
+    #
+    # @param [String] payload.memoryType . optional
+    #
+    # @param [Boolean] payload.withMediaOnly . optional
+    #
+    # `search_memories(strSessionID:, payload: {})`
     def self.search_memories(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'contextVars',
+        'contextVarsToSet',
         'date',
         'dateUncertaintyDays',
         'excludedMemoryIDs',
         'ignoreLastRead',
+        'memoryTags',
+        'memoryType',
         'numberOfResults',
         'placeLatitude',
         'placeLongitude',
         'placeName',
         'placeUncertaintyKm',
         'searchType',
+        'startFrom',
         'tag',
         'text',
+        'withMediaOnly',
       ]
       payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
@@ -42,41 +74,151 @@ class MemoriClient::Engine::V2::Search < MemoriClient::Engine::Resource
       exec_http_request('post', '/memori/v2/Search/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/Random/{strSessionID}
+    # `POST /memori/v2/Search/{strSessionID}/{from}/{howMany}`
+    #
+    # Searches for matching Memory objects, with pagination.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [integer] from The 0-based index of the first Memory object to list. required
+    #
+    # @param [integer] howMany The number of the Memory objects to list. required
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.text . optional
+    #
+    # @param [String] payload.searchType . optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # @param [Number] payload.dateUncertaintyDays . optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.placeLatitude . optional
+    #
+    # @param [Number] payload.placeLongitude . optional
+    #
+    # @param [Number] payload.placeUncertaintyKm . optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # @param [Boolean] payload.ignoreLastRead . optional
+    #
+    # @param [Array] payload.excludedMemoryIDs . optional
+    #
+    # @param [Object] payload.contextVars . optional
+    #
+    # @param [Object] payload.contextVarsToSet . optional
+    #
+    # @param [Array] payload.memoryTags . optional
+    #
+    # @param [Integer] payload.numberOfResults . optional
+    #
+    # @param [Integer] payload.startFrom . optional
+    #
+    # @param [String] payload.memoryType . optional
+    #
+    # @param [Boolean] payload.withMediaOnly . optional
+    #
+    # `search_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
+    def self.search_memories_paginated(strSessionID:, from:, howMany:, payload: {})
+      args = build_arguments(binding)
+      payload_keys = [
+        'contextVars',
+        'contextVarsToSet',
+        'date',
+        'dateUncertaintyDays',
+        'excludedMemoryIDs',
+        'ignoreLastRead',
+        'memoryTags',
+        'memoryType',
+        'numberOfResults',
+        'placeLatitude',
+        'placeLongitude',
+        'placeName',
+        'placeUncertaintyKm',
+        'searchType',
+        'startFrom',
+        'tag',
+        'text',
+        'withMediaOnly',
+      ]
+      payload_required_keys = %w[]
+      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
+
+      exec_http_request('post', '/memori/v2/Search/{strSessionID}/{from}/{howMany}', **args)
+    end
+
+    # `POST /memori/v2/Random/{strSessionID}`
+    #
     # Picks up to 5 random Memory objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.text . optional
-    # @param [string] payload.searchType . optional
-    # @param [string] payload.date . optional
-    # @param [number] payload.dateUncertaintyDays . optional
-    # @param [string] payload.placeName . optional
-    # @param [number] payload.placeLatitude . optional
-    # @param [number] payload.placeLongitude . optional
-    # @param [number] payload.placeUncertaintyKm . optional
-    # @param [string] payload.tag . optional
-    # @param [boolean] payload.ignoreLastRead . optional
-    # @param [array] payload.excludedMemoryIDs . optional
-    # @param [object] payload.contextVars . optional
-    # @param [integer] payload.numberOfResults . optional
-    # get_random_memories(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.text . optional
+    #
+    # @param [String] payload.searchType . optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # @param [Number] payload.dateUncertaintyDays . optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.placeLatitude . optional
+    #
+    # @param [Number] payload.placeLongitude . optional
+    #
+    # @param [Number] payload.placeUncertaintyKm . optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # @param [Boolean] payload.ignoreLastRead . optional
+    #
+    # @param [Array] payload.excludedMemoryIDs . optional
+    #
+    # @param [Object] payload.contextVars . optional
+    #
+    # @param [Object] payload.contextVarsToSet . optional
+    #
+    # @param [Array] payload.memoryTags . optional
+    #
+    # @param [Integer] payload.numberOfResults . optional
+    #
+    # @param [Integer] payload.startFrom . optional
+    #
+    # @param [String] payload.memoryType . optional
+    #
+    # @param [Boolean] payload.withMediaOnly . optional
+    #
+    # `get_random_memories(strSessionID:, payload: {})`
     def self.get_random_memories(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'contextVars',
+        'contextVarsToSet',
         'date',
         'dateUncertaintyDays',
         'excludedMemoryIDs',
         'ignoreLastRead',
+        'memoryTags',
+        'memoryType',
         'numberOfResults',
         'placeLatitude',
         'placeLongitude',
         'placeName',
         'placeUncertaintyKm',
         'searchType',
+        'startFrom',
         'tag',
         'text',
+        'withMediaOnly',
       ]
       payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
@@ -84,41 +226,73 @@ class MemoriClient::Engine::V2::Search < MemoriClient::Engine::Resource
       exec_http_request('post', '/memori/v2/Random/{strSessionID}', **args)
     end
 
-    # POST /memori/v2/Hints/{strSessionID}
+    # `POST /memori/v2/Hints/{strSessionID}`
+    #
     # Picks up to 20 Memory Hint objects.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.text . optional
-    # @param [string] payload.searchType . optional
-    # @param [string] payload.date . optional
-    # @param [number] payload.dateUncertaintyDays . optional
-    # @param [string] payload.placeName . optional
-    # @param [number] payload.placeLatitude . optional
-    # @param [number] payload.placeLongitude . optional
-    # @param [number] payload.placeUncertaintyKm . optional
-    # @param [string] payload.tag . optional
-    # @param [boolean] payload.ignoreLastRead . optional
-    # @param [array] payload.excludedMemoryIDs . optional
-    # @param [object] payload.contextVars . optional
-    # @param [integer] payload.numberOfResults . optional
-    # get_memory_hints(strSessionID:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.text . optional
+    #
+    # @param [String] payload.searchType . optional
+    #
+    # @param [String] payload.date . optional
+    #
+    # @param [Number] payload.dateUncertaintyDays . optional
+    #
+    # @param [String] payload.placeName . optional
+    #
+    # @param [Number] payload.placeLatitude . optional
+    #
+    # @param [Number] payload.placeLongitude . optional
+    #
+    # @param [Number] payload.placeUncertaintyKm . optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # @param [Boolean] payload.ignoreLastRead . optional
+    #
+    # @param [Array] payload.excludedMemoryIDs . optional
+    #
+    # @param [Object] payload.contextVars . optional
+    #
+    # @param [Object] payload.contextVarsToSet . optional
+    #
+    # @param [Array] payload.memoryTags . optional
+    #
+    # @param [Integer] payload.numberOfResults . optional
+    #
+    # @param [Integer] payload.startFrom . optional
+    #
+    # @param [String] payload.memoryType . optional
+    #
+    # @param [Boolean] payload.withMediaOnly . optional
+    #
+    # `get_memory_hints(strSessionID:, payload: {})`
     def self.get_memory_hints(strSessionID:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
         'contextVars',
+        'contextVarsToSet',
         'date',
         'dateUncertaintyDays',
         'excludedMemoryIDs',
         'ignoreLastRead',
+        'memoryTags',
+        'memoryType',
         'numberOfResults',
         'placeLatitude',
         'placeLongitude',
         'placeName',
         'placeUncertaintyKm',
         'searchType',
+        'startFrom',
         'tag',
         'text',
+        'withMediaOnly',
       ]
       payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
@@ -126,5 +300,19 @@ class MemoriClient::Engine::V2::Search < MemoriClient::Engine::Resource
       exec_http_request('post', '/memori/v2/Hints/{strSessionID}', **args)
     end
 
+    # `GET /memori/v2/MemoryTags/{strSessionID}`
+    #
+    # Gets a list of all available memory tags.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # `list_memory_tags(strSessionID:)`
+    def self.list_memory_tags(strSessionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/MemoryTags/{strSessionID}', **args)
+    end
+
 
 end

data/lib/memori_client/engine/v2/session.rb

@@ -1,20 +1,33 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::Session < MemoriClient::Engine::Resource
-    # POST /memori/v2/Session
+    # `POST /memori/v2/Session`
+    #
     # Initializes a new Dialog State Machine session for an existing Memori.
-    # Params list:
-    # @param [object] payload request payload. optional
-    # @param [string] payload.memoriID . required
-    # @param [string] payload.password . optional
-    # @param [array] payload.recoveryTokens . optional
-    # @param [string] payload.tag . optional
-    # @param [string] payload.pin . optional
-    # @param [object] payload.initialContextVars . optional
-    # @param [string] payload.initialQuestion . optional
-    # @param [string] payload.birthDate . optional
-    # @param [string] payload.maintenanceCode . optional
-    # @param [object] payload.additionalInfo . optional
-    # open_session(payload: {})
+    #
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.memoriID . optional
+    #
+    # @param [String] payload.password . optional
+    #
+    # @param [Array] payload.recoveryTokens . optional
+    #
+    # @param [String] payload.tag . optional
+    #
+    # @param [String] payload.pin . optional
+    #
+    # @param [Object] payload.initialContextVars . optional
+    #
+    # @param [String] payload.initialQuestion . optional
+    #
+    # @param [String] payload.birthDate . optional
+    #
+    # @param [String] payload.maintenanceCode . optional
+    #
+    # @param [Object] payload.additionalInfo . optional
+    #
+    # `open_session(payload: {})`
     def self.open_session(payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -29,28 +42,34 @@ class MemoriClient::Engine::V2::Session < MemoriClient::Engine::Resource
         'recoveryTokens',
         'tag',
       ]
-      payload_required_keys = %w[memoriID]
+      payload_required_keys = %w[]
       validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
 
       exec_http_request('post', '/memori/v2/Session', **args)
     end
 
-    # GET /memori/v2/Session/{strSessionID}
+    # `GET /memori/v2/Session/{strSessionID}`
+    #
     # Returns the current state of a session's Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # get_current_state(strSessionID:)
+    #
+    # `get_current_state(strSessionID:)`
     def self.get_current_state(strSessionID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/Session/{strSessionID}', **args)
     end
 
-    # DELETE /memori/v2/Session/{strSessionID}
+    # `DELETE /memori/v2/Session/{strSessionID}`
+    #
     # Closes the session and disposes of its Dialog State Machine.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
-    # close_session(strSessionID:)
+    #
+    # `close_session(strSessionID:)`
     def self.close_session(strSessionID:)
       args = build_arguments(binding)
 

data/lib/memori_client/engine/v2/stat.rb

@@ -1,52 +1,20 @@
-# Generated on 2024-01-18 17:37:07 +0000    
+# Generated on 2025-01-27 20:29:52 +0000    
 class MemoriClient::Engine::V2::Stat < MemoriClient::Engine::Resource
-    # GET /memori/v2/Statistics/{strSessionID}
-    # Computes usage statistics for the Memori of the current session.
-    # Params list:
-    # @param [string] strSessionID The session ID. required
-    # get_statistics(strSessionID:)
-    def self.get_statistics(strSessionID:)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/memori/v2/Statistics/{strSessionID}', **args)
-    end
-
-    # GET /memori/v2/ContentQualityIndexes/{strMemoriID}/{strLatestUpdate}
-    # Computes content quality indexes for a Memori.
-    # Params list:
-    # @param [string] strMemoriID The Memori object ID. required
-    # @param [string] strLatestUpdate The optional latest update timestamp, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # get_content_quality_indexes(strMemoriID:, strLatestUpdate: nil)
-    def self.get_content_quality_indexes(strMemoriID:, strLatestUpdate: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/memori/v2/ContentQualityIndexes/{strMemoriID}/{strLatestUpdate}', **args)
-    end
-
-    # GET /memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate}
+    # `GET /memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate}`
+    #
     # Computes text quality indexes for a Memori.
-    # Params list:
+    #
+    #
     # @param [string] strSessionID The session ID. required
+    #
     # @param [string] strLatestUpdate The optional latest update timestamp, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # get_text_quality_indexes(strSessionID:, strLatestUpdate: nil)
+    #
+    # `get_text_quality_indexes(strSessionID:, strLatestUpdate: nil)`
     def self.get_text_quality_indexes(strSessionID:, strLatestUpdate: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate}', **args)
     end
 
-    # GET /memori/v2/SessionStatistics/{strMemoriID}/{strDateFrom}/{strDateTo}
-    # Computes session statistics for the specified Memori in a specific date interval.
-    # Params list:
-    # @param [string] strMemoriID The Memori object ID. required
-    # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
-    # get_session_statistics(strMemoriID:, strDateFrom: nil, strDateTo: nil)
-    def self.get_session_statistics(strMemoriID:, strDateFrom: nil, strDateTo: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/memori/v2/SessionStatistics/{strMemoriID}/{strDateFrom}/{strDateTo}', **args)
-    end
-
 
 end

data/lib/memori_client/engine/v2/topic.rb

@@ -0,0 +1,88 @@
+# Generated on 2025-01-27 20:29:52 +0000    
+class MemoriClient::Engine::V2::Topic < MemoriClient::Engine::Resource
+    # `GET /memori/v2/Topics/{strSessionID}`
+    #
+    # Lists all Topic objects.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # `list_topics(strSessionID:)`
+    def self.list_topics(strSessionID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Topics/{strSessionID}', **args)
+    end
+
+    # `GET /memori/v2/Topics/{strSessionID}/{from}/{howMany}`
+    #
+    # Lists Topic objects with pagination.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [integer] from The 0-based index of the first Topic object to list. required
+    #
+    # @param [integer] howMany The number of the Topic objects to list. required
+    #
+    # `list_topics_paginated(strSessionID:, from:, howMany:)`
+    def self.list_topics_paginated(strSessionID:, from:, howMany:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Topics/{strSessionID}/{from}/{howMany}', **args)
+    end
+
+    # `GET /memori/v2/Topic/{strSessionID}/{strTopicID}`
+    #
+    # Gets the details of a Topic object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strTopicID The Topic object ID. required
+    #
+    # `get_topic(strSessionID:, strTopicID:)`
+    def self.get_topic(strSessionID:, strTopicID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/Topic/{strSessionID}/{strTopicID}', **args)
+    end
+
+    # `GET /memori/v2/TopicUsers/{strSessionID}/{strTopicID}`
+    #
+    # Lists all User objects referencing a specified Topic object.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strTopicID The Topic object ID. required
+    #
+    # `list_topic_users(strSessionID:, strTopicID:)`
+    def self.list_topic_users(strSessionID:, strTopicID:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/TopicUsers/{strSessionID}/{strTopicID}', **args)
+    end
+
+    # `GET /memori/v2/TopicUsers/{strSessionID}/{strTopicID}/{from}/{howMany}`
+    #
+    # Lists User objects referencing a specified User object, with pagination.
+    #
+    #
+    # @param [string] strSessionID The session ID. required
+    #
+    # @param [string] strTopicID The Topic object ID. required
+    #
+    # @param [integer] from The 0-based index of the first User object to list. required
+    #
+    # @param [integer] howMany The number of User objects to list. required
+    #
+    # `list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)`
+    def self.list_topic_users_paginated(strSessionID:, strTopicID:, from:, howMany:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/memori/v2/TopicUsers/{strSessionID}/{strTopicID}/{from}/{howMany}', **args)
+    end
+
+
+end