memori-client 0.1.8 → 0.2.1

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

@@ -1,202 +0,0 @@
-# Generated on 2025-01-27 20:29:51 +0000    
-class MemoriClient::Backend::V2::CompletionConfig < MemoriClient::Backend::Resource
-    # `GET /api/v2/CompletionConfigs/{strToken}/{purpose}`
-    #
-    # Gets a list of Completion Config objects allowed for the user.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] purpose Optional filter on Completion Config purpose ("QA" for Question Answering, "IE" for Import/Export, "DT" for Deep Thought).. optional
-    #
-    # `list_completion_configs(strToken:, purpose: nil)`
-    def self.list_completion_configs(strToken:, purpose: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/api/v2/CompletionConfigs/{strToken}/{purpose}', **args)
-    end
-
-    # `GET /api/v2/CompletionConfig/{strToken}/{strConfigID}`
-    #
-    # Gets the details of a Completion Config of a specific object
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strConfigID The Completion Config object ID. required
-    #
-    # `get_completion_config(strToken:, strConfigID:)`
-    def self.get_completion_config(strToken:, strConfigID:)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/api/v2/CompletionConfig/{strToken}/{strConfigID}', **args)
-    end
-
-    # `PATCH /api/v2/CompletionConfig/{strToken}/{strConfigID}`
-    #
-    # Updates an existing Completion Config object.  A user can only update a Completion Config object owned by him,  unless it has administrative rights.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strConfigID The ID of the Completion Config object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [String] payload.completionConfigID . optional
-    #
-    # @param [String] payload.configName . optional
-    #
-    # @param [String] payload.description . optional
-    #
-    # @param [String] payload.provider . optional
-    #
-    # @param [String] payload.endPoint . optional
-    #
-    # @param [String] payload.apiKey . optional
-    #
-    # @param [String] payload.model . optional
-    #
-    # @param [Boolean] payload.questionAnsweringEnabled . optional
-    #
-    # @param [Boolean] payload.importExportEnabled . optional
-    #
-    # @param [Boolean] payload.deepThoughtEnabled . optional
-    #
-    # @param [String] payload.ownerUserID . optional
-    #
-    # @param [String] payload.ownerUserName . optional
-    #
-    # @param [String] payload.ownerTenantName . optional
-    #
-    # @param [Boolean] payload.visibleToTenantUsers . optional
-    #
-    # @param [Boolean] payload.visibleToOtherUsers . optional
-    #
-    # @param [Boolean] payload.useAsDefault . optional
-    #
-    # @param [Boolean] payload.chargeable . optional
-    #
-    # @param [String] payload.applyTo . optional
-    #
-    # `update_completion_config(strToken:, strConfigID:, payload: {})`
-    def self.update_completion_config(strToken:, strConfigID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'apiKey',
-        'applyTo',
-        'chargeable',
-        'completionConfigID',
-        'configName',
-        'deepThoughtEnabled',
-        'description',
-        'endPoint',
-        'importExportEnabled',
-        'model',
-        'ownerTenantName',
-        'ownerUserID',
-        'ownerUserName',
-        'provider',
-        'questionAnsweringEnabled',
-        'useAsDefault',
-        'visibleToOtherUsers',
-        'visibleToTenantUsers',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('patch', '/api/v2/CompletionConfig/{strToken}/{strConfigID}', **args)
-    end
-
-    # `DELETE /api/v2/CompletionConfig/{strToken}/{strConfigID}`
-    #
-    # Deletes an existing Completion Config object.  A user can only delete a Completion Config object owned by him,  unless it has administrative rights.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strConfigID The ID of the Completion Config object. required
-    #
-    # `delete_completion_config(strToken:, strConfigID:)`
-    def self.delete_completion_config(strToken:, strConfigID:)
-      args = build_arguments(binding)
-
-      exec_http_request('delete', '/api/v2/CompletionConfig/{strToken}/{strConfigID}', **args)
-    end
-
-    # `POST /api/v2/CompletionConfig/{strToken}`
-    #
-    # Creates a new Completion Config object.  The created Completion Config object is owned by the currently logged-in user.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [String] payload.completionConfigID . optional
-    #
-    # @param [String] payload.configName . optional
-    #
-    # @param [String] payload.description . optional
-    #
-    # @param [String] payload.provider . optional
-    #
-    # @param [String] payload.endPoint . optional
-    #
-    # @param [String] payload.apiKey . optional
-    #
-    # @param [String] payload.model . optional
-    #
-    # @param [Boolean] payload.questionAnsweringEnabled . optional
-    #
-    # @param [Boolean] payload.importExportEnabled . optional
-    #
-    # @param [Boolean] payload.deepThoughtEnabled . optional
-    #
-    # @param [String] payload.ownerUserID . optional
-    #
-    # @param [String] payload.ownerUserName . optional
-    #
-    # @param [String] payload.ownerTenantName . optional
-    #
-    # @param [Boolean] payload.visibleToTenantUsers . optional
-    #
-    # @param [Boolean] payload.visibleToOtherUsers . optional
-    #
-    # @param [Boolean] payload.useAsDefault . optional
-    #
-    # @param [Boolean] payload.chargeable . optional
-    #
-    # @param [String] payload.applyTo . optional
-    #
-    # `add_completion_config(strToken:, payload: {})`
-    def self.add_completion_config(strToken:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'apiKey',
-        'applyTo',
-        'chargeable',
-        'completionConfigID',
-        'configName',
-        'deepThoughtEnabled',
-        'description',
-        'endPoint',
-        'importExportEnabled',
-        'model',
-        'ownerTenantName',
-        'ownerUserID',
-        'ownerUserName',
-        'provider',
-        'questionAnsweringEnabled',
-        'useAsDefault',
-        'visibleToOtherUsers',
-        'visibleToTenantUsers',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/CompletionConfig/{strToken}', **args)
-    end
-
-
-end

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

@@ -1,70 +0,0 @@
-# Generated on 2025-01-27 20:29:51 +0000    
-class MemoriClient::Backend::V2::ConsumptionLog < MemoriClient::Backend::Resource
-    # `GET /api/v2/TenantConsumptionLogs/{strToken}/{tenantName}/{strType}/{strDateFrom}/{strDateTo}`
-    #
-    # Gets the Consumption Log objects for a specific Tenant in a specific date interval.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] tenantName The name of the Tenant. required
-    #
-    # @param [string] strType Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
-    #
-    # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # `get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)`
-    def self.get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/api/v2/TenantConsumptionLogs/{strToken}/{tenantName}/{strType}/{strDateFrom}/{strDateTo}', **args)
-    end
-
-    # `GET /api/v2/UserConsumptionLogs/{strToken}/{strUserID}/{strType}/{strDateFrom}/{strDateTo}`
-    #
-    # Gets the Consumption Log objects for a specific User in a specific date interval.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strUserID The ID of the User object. required
-    #
-    # @param [string] strType Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
-    #
-    # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # `get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)`
-    def self.get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/api/v2/UserConsumptionLogs/{strToken}/{strUserID}/{strType}/{strDateFrom}/{strDateTo}', **args)
-    end
-
-    # `GET /api/v2/MemoriConsumptionLogs/{strToken}/{strMemoriID}/{strType}/{strDateFrom}/{strDateTo}`
-    #
-    # Gets the Consumption Log objects for a specific Memori in a specific date interval.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [string] strType Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
-    #
-    # @param [string] strDateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # @param [string] strDateTo The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
-    #
-    # `get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)`
-    def self.get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)
-      args = build_arguments(binding)
-
-      exec_http_request('get', '/api/v2/MemoriConsumptionLogs/{strToken}/{strMemoriID}/{strType}/{strDateFrom}/{strDateTo}', **args)
-    end
-
-
-end

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

@@ -1,327 +0,0 @@
-# Generated on 2025-01-27 20:29:51 +0000    
-class MemoriClient::Backend::V2::ImportExport < MemoriClient::Backend::Resource
-    # `POST /api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}`
-    #
-    # Starts an Import process for memories from a CSV file.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [] payload.csvSpecs . optional
-    #
-    # @param [Boolean] payload.conclusive . optional
-    #
-    # @param [Boolean] payload.notPickable . optional
-    #
-    # @param [Object] payload.contextVarsToSet . optional
-    #
-    # @param [Object] payload.contextVarsToMatch . optional
-    #
-    # @param [Array] payload.memoryTags . optional
-    #
-    # @param [String] payload.receiverID . optional
-    #
-    # @param [String] payload.addMediaLink . optional
-    #
-    # @param [String] payload.linkTitleHandling . optional
-    #
-    # @param [String] payload.linkTitle . optional
-    #
-    # @param [Array] payload.rows . optional
-    #
-    # @param [String] payload.importName . optional
-    #
-    # @param [Boolean] payload.forceImport . optional
-    #
-    # @param [String] payload.notes . optional
-    #
-    # `import_csv(strToken:, strMemoriID:, payload: {})`
-    def self.import_csv(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'addMediaLink',
-        'conclusive',
-        'contextVarsToMatch',
-        'contextVarsToSet',
-        'csvSpecs',
-        'forceImport',
-        'importName',
-        'linkTitle',
-        'linkTitleHandling',
-        'memoryTags',
-        'notPickable',
-        'notes',
-        'receiverID',
-        'rows',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}`
-    #
-    # Starts an Import process for memories from a TXT file.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [] payload.txtSpecs . optional
-    #
-    # @param [Boolean] payload.conclusive . optional
-    #
-    # @param [Boolean] payload.notPickable . optional
-    #
-    # @param [Object] payload.contextVarsToSet . optional
-    #
-    # @param [Object] payload.contextVarsToMatch . optional
-    #
-    # @param [Array] payload.memoryTags . optional
-    #
-    # @param [String] payload.receiverID . optional
-    #
-    # @param [String] payload.addMediaLink . optional
-    #
-    # @param [String] payload.linkTitleHandling . optional
-    #
-    # @param [String] payload.linkTitle . optional
-    #
-    # @param [Array] payload.rows . optional
-    #
-    # @param [String] payload.importName . optional
-    #
-    # @param [Boolean] payload.forceImport . optional
-    #
-    # @param [String] payload.notes . optional
-    #
-    # `import_txt(strToken:, strMemoriID:, payload: {})`
-    def self.import_txt(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'addMediaLink',
-        'conclusive',
-        'contextVarsToMatch',
-        'contextVarsToSet',
-        'forceImport',
-        'importName',
-        'linkTitle',
-        'linkTitleHandling',
-        'memoryTags',
-        'notPickable',
-        'notes',
-        'receiverID',
-        'rows',
-        'txtSpecs',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}`
-    #
-    # Starts an Import process for functions and intents from a jsonl file.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [Array] payload.rows . optional
-    #
-    # @param [String] payload.importName . optional
-    #
-    # @param [Boolean] payload.forceImport . optional
-    #
-    # @param [String] payload.notes . optional
-    #
-    # `import_functions_intents(strToken:, strMemoriID:, payload: {})`
-    def self.import_functions_intents(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'forceImport',
-        'importName',
-        'notes',
-        'rows',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}`
-    #
-    # Exports contents of a Memori object to a CSV file.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [] payload.csvSpecs . optional
-    #
-    # @param [String] payload.password . optional
-    #
-    # `export_csv(strToken:, strMemoriID:, payload: {})`
-    def self.export_csv(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'csvSpecs',
-        'password',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}`
-    #
-    # Exports contents of a Memori object to a JSONL file, suitable for  fine-tuning with generative AI platforms.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [] payload.jsonlSpecs . optional
-    #
-    # @param [String] payload.password . optional
-    #
-    # `export_jsonl(strToken:, strMemoriID:, payload: {})`
-    def self.export_jsonl(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'jsonlSpecs',
-        'password',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}`
-    #
-    # Exports functions, intents and intentSlots of a Memori object to a JSONL file
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [Boolean] payload.exportFunctions . optional
-    #
-    # @param [Boolean] payload.exportIntents . optional
-    #
-    # @param [Boolean] payload.exportIntentSlots . optional
-    #
-    # @param [Array] payload.functionsIds . optional
-    #
-    # @param [Array] payload.intentsIds . optional
-    #
-    # @param [Array] payload.intentSlotsIds . optional
-    #
-    # @param [String] payload.password . optional
-    #
-    # `export_functions_intents(strToken:, strMemoriID:, payload: {})`
-    def self.export_functions_intents(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'exportFunctions',
-        'exportIntentSlots',
-        'exportIntents',
-        'functionsIds',
-        'intentSlotsIds',
-        'intentsIds',
-        'password',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}`
-    #
-    # Imports a dictionary to a Memori object.
-    #
-    #
-    # @param [string] strToken . required
-    #
-    # @param [string] strMemoriID . required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [Array] payload.rows . optional
-    #
-    # @param [String] payload.importName . optional
-    #
-    # @param [Boolean] payload.forceImport . optional
-    #
-    # @param [String] payload.notes . optional
-    #
-    # `import_dictionary(strToken:, strMemoriID:, payload: {})`
-    def self.import_dictionary(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'forceImport',
-        'importName',
-        'notes',
-        'rows',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}', **args)
-    end
-
-    # `POST /api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}`
-    #
-    # Exports the dictionary of a Memori object to a JSONL file.
-    #
-    #
-    # @param [string] strToken The login token. required
-    #
-    # @param [string] strMemoriID The ID of the Memori object. required
-    #
-    # @param [Hash] payload request payload. optional
-    #
-    # @param [] payload.dictionarySpecs . optional
-    #
-    # @param [String] payload.password . optional
-    #
-    # `export_dictionary(strToken:, strMemoriID:, payload: {})`
-    def self.export_dictionary(strToken:, strMemoriID:, payload: {})
-      args = build_arguments(binding)
-      payload_keys = [
-        'dictionarySpecs',
-        'password',
-      ]
-      payload_required_keys = %w[]
-      validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
-
-      exec_http_request('post', '/api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}', **args)
-    end
-
-
-end