memori-client 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194c84094fe7132c5e579146ab372a6f9b9308a3c8e56b9c45c855a2b640926b
-  data.tar.gz: 9bf85231186fe11b9dbd27409fbdb899b55c25b6919c589fa118a4f07fb14df4
+  metadata.gz: 6c10fc0d10bce1ed59b4958dbf180ea960feff117101b2c9376a2bb584db64fe
+  data.tar.gz: 8b6274442472d9c9a175df35e07668066a857de6a022761fbca766c15fae4d74
 SHA512:
-  metadata.gz: f0cc6c0483826e2b78011a93b4542df1aa59f2a3c42f26de2b4d543b07d166019496a91dc86e35f642d001993cf928aa2ca23b72c40423d6a21a12f7e8729908
-  data.tar.gz: 69f717f3e33375c05972b7d3a47ee9aceef3d5b3c0f42a42efccfbb30acdf72ec4d914fb2316f340bac9096e3c97f351eff2b4ce508c1c2911d191b4613269f4
+  metadata.gz: e5e5b9e4607847f63fb0de2919799773187d50740c1554cb3466c797ffd2d82cfc8547b33ee6c6967f09aa4369671560cb13eeca14be0a3ca1989553ca43fe9d
+  data.tar.gz: 7115e5babdddb0b6e7448a60de84fc92875d5051011ad975e77ad40a45e6db4110362bcea2419aa0de7aa69fb9d601f89206ecbddb53ef92bbfadef398f97c1d

data/lib/memori_client/backend/resources.rb

@@ -1,7 +1,9 @@
 require 'memori_client/backend/v2/action_log.rb'
+require 'memori_client/backend/v2/analysis.rb'
 require 'memori_client/backend/v2/asset.rb'
 require 'memori_client/backend/v1/asset.rb'
 require 'memori_client/backend/v2/badge.rb'
+require 'memori_client/backend/v2/completion_config.rb'
 require 'memori_client/backend/v2/consumption_log.rb'
 require 'memori_client/backend/v2/import_export.rb'
 require 'memori_client/backend/v2/integration.rb'
@@ -9,5 +11,6 @@ require 'memori_client/backend/v2/invitation.rb'
 require 'memori_client/backend/v2/memori.rb'
 require 'memori_client/backend/v2/memori_list.rb'
 require 'memori_client/backend/v2/notification.rb'
+require 'memori_client/backend/v2/process.rb'
 require 'memori_client/backend/v2/tenant.rb'
 require 'memori_client/backend/v2/user.rb'

data/lib/memori_client/backend/v1/asset.rb

@@ -1,89 +1,115 @@
-# Generated on 2024-01-18 17:37:06 +0000    
+# Generated on 2025-01-27 20:29:51 +0000    
 class MemoriClient::Backend::V1::Asset < MemoriClient::Backend::Resource
-    # GET /api/v1/GuidAsset/{assetID}
+    # `GET /api/v1/GuidAsset/{assetID}`
+    #
     # Downloads a file from an old Guid asset file URL, such as  ```guid://<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] assetID ID of the old Guid asset file. required
-    # download_old_guid_asset(assetID:)
+    #
+    # `download_old_guid_asset(assetID:)`
     def self.download_old_guid_asset(assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/GuidAsset/{assetID}', **args)
     end
 
-    # GET /api/v1/memoriai/memory/media/{assetID}
+    # `GET /api/v1/memoriai/memory/media/{assetID}`
+    #
     # Downloads a file from an old alternative Guid asset file URL, sucs as  ```/api/v1/memoriai/memory/media/<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] assetID ID of the old Guid asset file. required
-    # download_old_alternative_guid_asset(assetID:)
+    #
+    # `download_old_alternative_guid_asset(assetID:)`
     def self.download_old_alternative_guid_asset(assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/memoriai/memory/media/{assetID}', **args)
     end
 
-    # GET /api/v1/memoriai/memory/{strMemoryID}/media/{assetID}
+    # `GET /api/v1/memoriai/memory/{strMemoryID}/media/{assetID}`
+    #
     # Downloads a file from an old alternative Guid asset file URL, sucs as  ```/api/v1/memoriai/memory/<memoryID>/media/<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] strMemoryID ID of the engine Memory object (ignored). required
+    #
     # @param [string] assetID ID of the old Guid asset file. required
-    # download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)
+    #
+    # `download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)`
     def self.download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/memoriai/memory/{strMemoryID}/media/{assetID}', **args)
     end
 
-    # GET /api/v1/CloudAsset/{assetID}
+    # `GET /api/v1/CloudAsset/{assetID}`
+    #
     # Downloads a file from an old Cloud asset file URL, such as  ```cloud://<path>/<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] assetID ID of the old Cloud asset file. required
-    # download_old_cloud_asset(assetID:)
+    #
+    # `download_old_cloud_asset(assetID:)`
     def self.download_old_cloud_asset(assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/CloudAsset/{assetID}', **args)
     end
 
-    # GET /api/v1/memoriai/memory/media/cloud/{assetID}
+    # `GET /api/v1/memoriai/memory/media/cloud/{assetID}`
+    #
     # Downloads a file from an old asset file URL, such as  ```/api/v1/memoriai/memory/media/cloud/<path>/<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] assetID ID of the old asset file. required
-    # download_old_asset(assetID:)
+    #
+    # `download_old_asset(assetID:)`
     def self.download_old_asset(assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/memoriai/memory/media/cloud/{assetID}', **args)
     end
 
-    # GET /api/v1/memoriai/memory/{strMemoryID}/media/cloud/{assetID}
+    # `GET /api/v1/memoriai/memory/{strMemoryID}/media/cloud/{assetID}`
+    #
     # Downloads a file from an old asset file URL, such as  ```/api/v1/memoriai/memory/<memoryID>/media/cloud/<path>/<assetID>.<ext>```.
-    # Params list:
+    #
+    #
     # @param [string] strMemoryID ID of the engine Memory object. required
+    #
     # @param [string] assetID ID of the old asset file. required
-    # download_old_asset_with_memory_check(strMemoryID:, assetID:)
+    #
+    # `download_old_asset_with_memory_check(strMemoryID:, assetID:)`
     def self.download_old_asset_with_memory_check(strMemoryID:, assetID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/memoriai/memory/{strMemoryID}/media/cloud/{assetID}', **args)
     end
 
-    # GET /api/v1/memoriai/memori/cover/{strMemoriID}
+    # `GET /api/v1/memoriai/memori/cover/{strMemoriID}`
+    #
     # Downloads the cover file from an old cover asset URL, sucs as  ```/api/v1/memoriai/memori/cover/<memoriID>```.
-    # Params list:
+    #
+    #
     # @param [string] strMemoriID ID of the engine Memori object. required
-    # download_old_cover_asset(strMemoriID:)
+    #
+    # `download_old_cover_asset(strMemoriID:)`
     def self.download_old_cover_asset(strMemoriID:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v1/memoriai/memori/cover/{strMemoriID}', **args)
     end
 
-    # GET /api/v1/memoriai/memori/avatar/{strMemoriID}
+    # `GET /api/v1/memoriai/memori/avatar/{strMemoriID}`
+    #
     # Downloads the avatar file from an old avatar asset URL, sucs as  ```/api/v1/memoriai/memori/avatar/<memoriID>```.
-    # Params list:
+    #
+    #
     # @param [string] strMemoriID ID of the engine Memori object. required
-    # download_old_avatar_asset(strMemoriID:)
+    #
+    # `download_old_avatar_asset(strMemoriID:)`
     def self.download_old_avatar_asset(strMemoriID:)
       args = build_arguments(binding)
 

data/lib/memori_client/backend/v2/action_log.rb

@@ -1,27 +1,39 @@
-# Generated on 2024-01-18 17:37:06 +0000    
+# Generated on 2025-01-27 20:29:51 +0000    
 class MemoriClient::Backend::V2::ActionLog < MemoriClient::Backend::Resource
-    # GET /api/v2/UserActionLogs/{strToken}/{strUserID}/{strDateFrom}/{strDateTo}
+    # `GET /api/v2/UserActionLogs/{strToken}/{strUserID}/{strDateFrom}/{strDateTo}`
+    #
     # Gets the Action Log objects for a specific User in a specific date interval.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] strUserID The ID of the User object. 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_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)
+    #
+    # `get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)`
     def self.get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v2/UserActionLogs/{strToken}/{strUserID}/{strDateFrom}/{strDateTo}', **args)
     end
 
-    # GET /api/v2/MemoriActionLogs/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo}
+    # `GET /api/v2/MemoriActionLogs/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo}`
+    #
     # Gets the Action Log objects for a specific Memori in a specific date interval.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] strMemoriID The ID of the Memori object. required
+    #
     # @param [string] strDateFrom The optional begin of the date interval, in the format yyyyMMddHHmmssfff. optional
+    #
     # @param [string] strDateTo The optional end of the date interval, in the format yyyyMMddHHmmssfff. optional
-    # get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)
+    #
+    # `get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
     def self.get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)
       args = build_arguments(binding)
 

data/lib/memori_client/backend/v2/analysis.rb

@@ -0,0 +1,54 @@
+# Generated on 2025-01-27 20:29:51 +0000    
+class MemoriClient::Backend::V2::Analysis < MemoriClient::Backend::Resource
+    # `POST /api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID}`
+    #
+    # Starts an Analysis process for User/query match on Deep Thought known facts.
+    #
+    #
+    # @param [string] strToken The login token. required
+    #
+    # @param [string] strMemoriID The ID of the Memori object. required
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.query . optional
+    #
+    # @param [Number] payload.threshold . optional
+    #
+    # `analyze_user_query(strToken:, strMemoriID:, payload: {})`
+    def self.analyze_user_query(strToken:, strMemoriID:, payload: {})
+      args = build_arguments(binding)
+      payload_keys = [
+        'query',
+        'threshold',
+      ]
+      payload_required_keys = %w[]
+      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
+
+      exec_http_request('post', '/api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID}', **args)
+    end
+
+    # `GET /api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}`
+    #
+    # Lists Deep Thought User/query Match objects of the specified Analysis object, with pagination.
+    #
+    #
+    # @param [string] strToken The login token. required
+    #
+    # @param [string] strAnalysisID The Analysis process ID. required
+    #
+    # @param [integer] from The 0-based index of the first Match object to list. required
+    #
+    # @param [integer] howMany The number of the Match objects to list. required
+    #
+    # @param [number] threshold Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list. optional
+    #
+    # `list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`
+    def self.list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}', **args)
+    end
+
+
+end

data/lib/memori_client/backend/v2/asset.rb

@@ -1,45 +1,97 @@
-# Generated on 2024-01-18 17:37:06 +0000    
+# Generated on 2025-01-27 20:29:51 +0000    
 class MemoriClient::Backend::V2::Asset < MemoriClient::Backend::Resource
-    # POST /api/v2/Asset/{strToken}/{strMemoriID}/{strEngineMemoryID}
+    # `POST /api/v2/Asset/{strToken}/{strMemoriID}/{strEngineMemoryID}`
+    #
     # Uploads a file and creates a new Asset object to access it.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
-    # @param [string] strMemoriID The ID of a Memori object the Asset belongs to. optional
+    #
+    # @param [string] strMemoriID The optional ID of a Memori object the Asset belongs to. optional
+    #
     # @param [string] strEngineMemoryID The optional ID of an Engine Memory object the Asset belogs to. optional
-    # upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)
+    #
+    # `upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)`
     def self.upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)
       args = build_arguments(binding)
 
       exec_http_request('post', '/api/v2/Asset/{strToken}/{strMemoriID}/{strEngineMemoryID}', **args)
     end
 
-    # GET /api/v2/Asset/{fileName}/{memoriSessionID}
+    # `GET /api/v2/AssetDetails/{strToken}/{fileName}`
+    #
+    # Gets the details of an Asset object.
+    #
+    #
+    # @param [string] strToken The login token. required
+    #
+    # @param [string] fileName Name of the Asset file. required
+    #
+    # `get_asset_details(strToken:, fileName:)`
+    def self.get_asset_details(strToken:, fileName:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/api/v2/AssetDetails/{strToken}/{fileName}', **args)
+    end
+
+    # `GET /api/v2/Assets/{strToken}`
+    #
+    # Gets a list of Asset objects owned the currently logged in User.
+    #
+    #
+    # @param [string] strToken The login token. required
+    #
+    # `list_sent_invitations(strToken:)`
+    def self.list_sent_invitations(strToken:)
+      args = build_arguments(binding)
+
+      exec_http_request('get', '/api/v2/Assets/{strToken}', **args)
+    end
+
+    # `GET /api/v2/Asset/{fileName}/{memoriSessionID}`
+    #
     # Downloads a file from an Asset object.
-    # Params list:
+    #
+    #
     # @param [string] fileName Name of the Asset file. required
+    #
     # @param [string] memoriSessionID Optional ID of an Engine Memori session. optional
-    # download_asset(fileName:, memoriSessionID: nil)
+    #
+    # `download_asset(fileName:, memoriSessionID: nil)`
     def self.download_asset(fileName:, memoriSessionID: nil)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v2/Asset/{fileName}/{memoriSessionID}', **args)
     end
 
-    # PATCH /api/v2/Asset/{strToken}/{fileName}
+    # `PATCH /api/v2/Asset/{strToken}/{fileName}`
+    #
     # Updates an Asset object.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] fileName Name of the Asset file. required
-    # @param [object] payload request payload. optional
-    # @param [string] payload.assetID . optional
-    # @param [string] payload.assetURL . optional
-    # @param [string] payload.mimeType . optional
-    # @param [string] payload.originalFileName . optional
-    # @param [string] payload.memoriID . optional
-    # @param [string] payload.engineMemoryID . optional
-    # @param [string] payload.creationTimestamp . optional
-    # @param [string] payload.lastChangeTimestamp . optional
-    # update_asset(strToken:, fileName:, payload: {})
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.assetID . optional
+    #
+    # @param [String] payload.assetURL . optional
+    #
+    # @param [String] payload.mimeType . optional
+    #
+    # @param [String] payload.originalFileName . optional
+    #
+    # @param [String] payload.memoriID . optional
+    #
+    # @param [String] payload.engineMemoryID . optional
+    #
+    # @param [String] payload.creationTimestamp . optional
+    #
+    # @param [String] payload.lastChangeTimestamp . optional
+    #
+    # `update_asset(strToken:, fileName:, payload: {})`
     def self.update_asset(strToken:, fileName:, payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -58,12 +110,16 @@ class MemoriClient::Backend::V2::Asset < MemoriClient::Backend::Resource
       exec_http_request('patch', '/api/v2/Asset/{strToken}/{fileName}', **args)
     end
 
-    # DELETE /api/v2/Asset/{strToken}/{fileName}
+    # `DELETE /api/v2/Asset/{strToken}/{fileName}`
+    #
     # Deletes a file and its corresponding Asset object.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] fileName Name of the Asset file. required
-    # delete_asset(strToken:, fileName:)
+    #
+    # `delete_asset(strToken:, fileName:)`
     def self.delete_asset(strToken:, fileName:)
       args = build_arguments(binding)
 

data/lib/memori_client/backend/v2/badge.rb

@@ -1,25 +1,35 @@
-# Generated on 2024-01-18 17:37:06 +0000    
+# Generated on 2025-01-27 20:29:51 +0000    
 class MemoriClient::Backend::V2::Badge < MemoriClient::Backend::Resource
-    # POST /api/v2/Outcome/{strToken}/{outcomeCode}
+    # `POST /api/v2/Outcome/{strToken}/{outcomeCode}`
+    #
     # Processes the specified outcome.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] outcomeCode The outcome code. required
-    # send_outcome(strToken:, outcomeCode:)
+    #
+    # `send_outcome(strToken:, outcomeCode:)`
     def self.send_outcome(strToken:, outcomeCode:)
       args = build_arguments(binding)
 
       exec_http_request('post', '/api/v2/Outcome/{strToken}/{outcomeCode}', **args)
     end
 
-    # POST /api/v2/BadgeAssignment
+    # `POST /api/v2/BadgeAssignment`
+    #
     # Processes a badge assignment.
-    # Params list:
-    # @param [object] payload request payload. optional
-    # @param [string] payload.refId . required
-    # @param [string] payload.outcome . required
-    # @param [string] payload.badgeUrl . required
-    # badge_assignment_callback(payload: {})
+    #
+    #
+    # @param [Hash] payload request payload. optional
+    #
+    # @param [String] payload.refId . required
+    #
+    # @param [String] payload.outcome . required
+    #
+    # @param [String] payload.badgeUrl . required
+    #
+    # `badge_assignment_callback(payload: {})`
     def self.badge_assignment_callback(payload: {})
       args = build_arguments(binding)
       payload_keys = [
@@ -33,23 +43,30 @@ class MemoriClient::Backend::V2::Badge < MemoriClient::Backend::Resource
       exec_http_request('post', '/api/v2/BadgeAssignment', **args)
     end
 
-    # GET /api/v2/Badges/{strToken}
+    # `GET /api/v2/Badges/{strToken}`
+    #
     # Gets a list of Badge objects assigned to the currently logged in User.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
-    # list_badges(strToken:)
+    #
+    # `list_badges(strToken:)`
     def self.list_badges(strToken:)
       args = build_arguments(binding)
 
       exec_http_request('get', '/api/v2/Badges/{strToken}', **args)
     end
 
-    # GET /api/v2/Badge/{strToken}/{strBadgeID}
+    # `GET /api/v2/Badge/{strToken}/{strBadgeID}`
+    #
     # Gets a list of Badge objects assigned to the currently logged in User.
-    # Params list:
+    #
+    #
     # @param [string] strToken The login token. required
+    #
     # @param [string] strBadgeID The ID of the Badge object. required
-    # get_badge(strToken:, strBadgeID:)
+    #
+    # `get_badge(strToken:, strBadgeID:)`
     def self.get_badge(strToken:, strBadgeID:)
       args = build_arguments(binding)