@pairsystems/goodmem-client 1.0.0-beta.1 → 1.0.0-dev.cb052d6

package/dist/api/EmbeddersApi.js

@@ -16,11 +16,11 @@ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o =
 function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * GoodMem API
- * API for interacting with the GoodMem service, providing vector-based memory storage and retrieval with multiple embedder support. The service enables creation of memory spaces, storing memories with vector representations, and efficient similarity-based retrieval.
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: v1
- * Contact: support@goodmem.io
+ * The version of the OpenAPI document: 
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Embedders service.
 * @module api/EmbeddersApi
-* @version v1
+* @version 1.0.0
 */
 var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -45,24 +45,15 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
     this.apiClient = apiClient || _ApiClient["default"].instance;
   }
 
-  /**
-   * Callback function to receive the result of the createEmbedder operation.
-   * @callback module:api/EmbeddersApi~createEmbedderCallback
-   * @param {String} error Error message, if any.
-   * @param {module:model/EmbedderResponse} data The data returned by the service call.
-   * @param {String} response The complete HTTP response.
-   */
-
   /**
    * Create a new embedder
-   * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces.
+   * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
    * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
-   * @param {module:api/EmbeddersApi~createEmbedderCallback} callback The callback function, accepting three arguments: error, data, response
-   * data is of type: {@link module:model/EmbedderResponse}
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
    */
   return _createClass(EmbeddersApi, [{
-    key: "createEmbedder",
-    value: function createEmbedder(embedderCreationRequest, callback) {
+    key: "createEmbedderWithHttpInfo",
+    value: function createEmbedderWithHttpInfo(embedderCreationRequest) {
       var postBody = embedderCreationRequest;
       // verify the required parameter 'embedderCreationRequest' is set
       if (embedderCreationRequest === undefined || embedderCreationRequest === null) {
@@ -76,26 +67,32 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
       var returnType = _EmbedderResponse["default"];
-      return this.apiClient.callApi('/v1/embedders', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/v1/embedders', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
-     * Callback function to receive the result of the deleteEmbedder operation.
-     * @callback module:api/EmbeddersApi~deleteEmbedderCallback
-     * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
-     * @param {String} response The complete HTTP response.
+     * Create a new embedder
+     * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
+     * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
      */
+  }, {
+    key: "createEmbedder",
+    value: function createEmbedder(embedderCreationRequest) {
+      return this.createEmbedderWithHttpInfo(embedderCreationRequest).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
 
     /**
      * Delete an embedder
-     * Deletes an embedder configuration. This operation cannot be undone.
+     * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to delete
-     * @param {module:api/EmbeddersApi~deleteEmbedderCallback} callback The callback function, accepting three arguments: error, data, response
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
   }, {
-    key: "deleteEmbedder",
-    value: function deleteEmbedder(id, callback) {
+    key: "deleteEmbedderWithHttpInfo",
+    value: function deleteEmbedderWithHttpInfo(id) {
       var postBody = null;
       // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
@@ -111,27 +108,32 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
       var contentTypes = [];
       var accepts = [];
       var returnType = null;
-      return this.apiClient.callApi('/v1/embedders/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/v1/embedders/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
-     * Callback function to receive the result of the getEmbedder operation.
-     * @callback module:api/EmbeddersApi~getEmbedderCallback
-     * @param {String} error Error message, if any.
-     * @param {module:model/EmbedderResponse} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
+     * Delete an embedder
+     * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
+     * @param {String} id The unique identifier of the embedder to delete
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
+  }, {
+    key: "deleteEmbedder",
+    value: function deleteEmbedder(id) {
+      return this.deleteEmbedderWithHttpInfo(id).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
 
     /**
      * Get an embedder by ID
-     * Retrieves the details of a specific embedder configuration by its unique identifier.
+     * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
      * @param {String} id The unique identifier of the embedder to retrieve
-     * @param {module:api/EmbeddersApi~getEmbedderCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/EmbedderResponse}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
      */
   }, {
-    key: "getEmbedder",
-    value: function getEmbedder(id, callback) {
+    key: "getEmbedderWithHttpInfo",
+    value: function getEmbedderWithHttpInfo(id) {
       var postBody = null;
       // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
@@ -147,30 +149,35 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
       var contentTypes = [];
       var accepts = ['application/json'];
       var returnType = _EmbedderResponse["default"];
-      return this.apiClient.callApi('/v1/embedders/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/v1/embedders/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
-     * Callback function to receive the result of the listEmbedders operation.
-     * @callback module:api/EmbeddersApi~listEmbeddersCallback
-     * @param {String} error Error message, if any.
-     * @param {module:model/ListEmbeddersResponse} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
+     * Get an embedder by ID
+     * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
+     * @param {String} id The unique identifier of the embedder to retrieve
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
      */
+  }, {
+    key: "getEmbedder",
+    value: function getEmbedder(id) {
+      return this.getEmbedderWithHttpInfo(id).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
 
     /**
      * List embedders
-     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering.
+     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
      * @param {Object} opts Optional parameters
-     * @param {String} [ownerId] Filter embedders by owner ID. If not provided, shows embedders based on permissions.
+     * @param {String} [ownerId] Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
      * @param {String} [providerType] Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
      * @param {String} [label] Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
-     * @param {module:api/EmbeddersApi~listEmbeddersCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/ListEmbeddersResponse}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmbeddersResponse} and HTTP response
      */
   }, {
-    key: "listEmbedders",
-    value: function listEmbedders(opts, callback) {
+    key: "listEmbeddersWithHttpInfo",
+    value: function listEmbeddersWithHttpInfo(opts) {
       opts = opts || {};
       var postBody = null;
       var pathParams = {};
@@ -185,28 +192,36 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
       var contentTypes = [];
       var accepts = ['application/json'];
       var returnType = _ListEmbeddersResponse["default"];
-      return this.apiClient.callApi('/v1/embedders', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/v1/embedders', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
-     * Callback function to receive the result of the updateEmbedder operation.
-     * @callback module:api/EmbeddersApi~updateEmbedderCallback
-     * @param {String} error Error message, if any.
-     * @param {module:model/EmbedderResponse} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
+     * List embedders
+     * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.ownerId Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
+     * @param {String} opts.providerType Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
+     * @param {String} opts.label Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListEmbeddersResponse}
      */
+  }, {
+    key: "listEmbedders",
+    value: function listEmbedders(opts) {
+      return this.listEmbeddersWithHttpInfo(opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
 
     /**
      * Update an embedder
-     * Updates an existing embedder configuration with new values for the specified fields.
+     * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
      * @param {String} id The unique identifier of the embedder to update
      * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
-     * @param {module:api/EmbeddersApi~updateEmbedderCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/EmbedderResponse}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
      */
   }, {
-    key: "updateEmbedder",
-    value: function updateEmbedder(id, updateEmbedderRequest, callback) {
+    key: "updateEmbedderWithHttpInfo",
+    value: function updateEmbedderWithHttpInfo(id, updateEmbedderRequest) {
       var postBody = updateEmbedderRequest;
       // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
@@ -226,7 +241,22 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
       var returnType = _EmbedderResponse["default"];
-      return this.apiClient.callApi('/v1/embedders/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/v1/embedders/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Update an embedder
+     * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
+     * @param {String} id The unique identifier of the embedder to update
+     * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
+     */
+  }, {
+    key: "updateEmbedder",
+    value: function updateEmbedder(id, updateEmbedderRequest) {
+      return this.updateEmbedderWithHttpInfo(id, updateEmbedderRequest).then(function (response_and_data) {
+        return response_and_data.data;
+      });
     }
   }]);
 }();