@nestbox-ai/doc-processing-api 1.0.69 → 1.0.71

package/dist/esm/api.js

@@ -1188,6 +1188,36 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Soft-deletes a profile by setting its deletedAt timestamp.
+         * @summary Delete profile
+         * @param {string} profileId Profile/config ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        profilesControllerDeleteProfile: (profileId_1, ...args_1) => __awaiter(this, [profileId_1, ...args_1], void 0, function* (profileId, options = {}) {
+            // verify required parameter 'profileId' is not null or undefined
+            assertParamExists('profilesControllerDeleteProfile', 'profileId', profileId);
+            const localVarPath = `/profiles/{profileId}`
+                .replace(`{${"profileId"}}`, encodeURIComponent(String(profileId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary Read profile
@@ -1250,10 +1280,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
          * @param {number} [page] 1-based page number.
          * @param {number} [limit] Page size.
          * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
+         * @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        profilesControllerListProfiles: (page_1, limit_1, tags_1, ...args_1) => __awaiter(this, [page_1, limit_1, tags_1, ...args_1], void 0, function* (page, limit, tags, options = {}) {
+        profilesControllerListProfiles: (page_1, limit_1, tags_1, includeDeleted_1, ...args_1) => __awaiter(this, [page_1, limit_1, tags_1, includeDeleted_1, ...args_1], void 0, function* (page, limit, tags, includeDeleted, options = {}) {
             const localVarPath = `/profiles`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1273,6 +1304,9 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
             if (tags) {
                 localVarQueryParameter['tags'] = tags;
             }
+            if (includeDeleted !== undefined) {
+                localVarQueryParameter['includeDeleted'] = includeDeleted;
+            }
             localVarHeaderParameter['Accept'] = 'application/json';
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1308,6 +1342,22 @@ export const ProfilesApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Soft-deletes a profile by setting its deletedAt timestamp.
+         * @summary Delete profile
+         * @param {string} profileId Profile/config ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        profilesControllerDeleteProfile(profileId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerDeleteProfile(profileId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerDeleteProfile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          *
          * @summary Read profile
@@ -1345,13 +1395,14 @@ export const ProfilesApiFp = function (configuration) {
          * @param {number} [page] 1-based page number.
          * @param {number} [limit] Page size.
          * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
+         * @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        profilesControllerListProfiles(page, limit, tags, options) {
+        profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, includeDeleted, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerListProfiles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1377,6 +1428,16 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
         profilesControllerCreateProfile(yaml, name, tags, options) {
             return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Soft-deletes a profile by setting its deletedAt timestamp.
+         * @summary Delete profile
+         * @param {string} profileId Profile/config ID.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        profilesControllerDeleteProfile(profileId, options) {
+            return localVarFp.profilesControllerDeleteProfile(profileId, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Read profile
@@ -1402,11 +1463,12 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
          * @param {number} [page] 1-based page number.
          * @param {number} [limit] Page size.
          * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
+         * @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        profilesControllerListProfiles(page, limit, tags, options) {
-            return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
+        profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
+            return localVarFp.profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -1426,6 +1488,16 @@ export class ProfilesApi extends BaseAPI {
     profilesControllerCreateProfile(yaml, name, tags, options) {
         return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Soft-deletes a profile by setting its deletedAt timestamp.
+     * @summary Delete profile
+     * @param {string} profileId Profile/config ID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    profilesControllerDeleteProfile(profileId, options) {
+        return ProfilesApiFp(this.configuration).profilesControllerDeleteProfile(profileId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Read profile
@@ -1451,11 +1523,12 @@ export class ProfilesApi extends BaseAPI {
      * @param {number} [page] 1-based page number.
      * @param {number} [limit] Page size.
      * @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
+     * @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    profilesControllerListProfiles(page, limit, tags, options) {
-        return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
+    profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
+        return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(this.axios, this.basePath));
     }
 }
 /**

package/docs/ProfileDto.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **description** | **string** | Profile description | [optional] [default to undefined]
 **createdAt** | **string** | Profile creation timestamp | [default to undefined]
 **updatedAt** | **string** | Profile last update timestamp | [optional] [default to undefined]
+**deletedAt** | **string** | Profile soft-deletion timestamp | [optional] [default to undefined]
 **yamlFileName** | **string** | YAML file name | [optional] [default to undefined]
 **yamlSha256** | **string** | Optional checksum of the uploaded YAML file | [optional] [default to undefined]
 **yamlFileContent** | **string** | Content of the YAML file | [optional] [default to undefined]
@@ -26,6 +27,7 @@ const instance: ProfileDto = {
     description,
     createdAt,
     updatedAt,
+    deletedAt,
     yamlFileName,
     yamlSha256,
     yamlFileContent,

package/docs/ProfilesApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**profilesControllerCreateProfile**](#profilescontrollercreateprofile) | **POST** /profiles | Create profile from YAML|
+|[**profilesControllerDeleteProfile**](#profilescontrollerdeleteprofile) | **DELETE** /profiles/{profileId} | Delete profile|
 |[**profilesControllerGetProfile**](#profilescontrollergetprofile) | **GET** /profiles/{profileId} | Read profile|
 |[**profilesControllerGetProfileSchema**](#profilescontrollergetprofileschema) | **GET** /profiles/schema | Get profile schema|
 |[**profilesControllerListProfiles**](#profilescontrollerlistprofiles) | **GET** /profiles | List profiles|
@@ -69,6 +70,59 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **profilesControllerDeleteProfile**
+> ProfileDto profilesControllerDeleteProfile()
+
+Soft-deletes a profile by setting its deletedAt timestamp.
+
+### Example
+
+```typescript
+import {
+    ProfilesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new ProfilesApi(configuration);
+
+let profileId: string; //Profile/config ID. (default to undefined)
+
+const { status, data } = await apiInstance.profilesControllerDeleteProfile(
+    profileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileId** | [**string**] | Profile/config ID. | defaults to undefined|
+
+
+### Return type
+
+**ProfileDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Profile soft-deleted |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **profilesControllerGetProfile**
 > ProfileDto profilesControllerGetProfile()
 
@@ -185,11 +239,13 @@ const apiInstance = new ProfilesApi(configuration);
 let page: number; //1-based page number. (optional) (default to 1)
 let limit: number; //Page size. (optional) (default to 10)
 let tags: Array<string>; //Filter profiles by tags (any match). Pass multiple times or comma-separated. (optional) (default to undefined)
+let includeDeleted: boolean; //Include soft-deleted profiles in the results. Defaults to false. (optional) (default to false)
 
 const { status, data } = await apiInstance.profilesControllerListProfiles(
     page,
     limit,
-    tags
+    tags,
+    includeDeleted
 );
 ```
 
@@ -200,6 +256,7 @@ const { status, data } = await apiInstance.profilesControllerListProfiles(
 | **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
 | **limit** | [**number**] | Page size. | (optional) defaults to 10|
 | **tags** | **Array&lt;string&gt;** | Filter profiles by tags (any match). Pass multiple times or comma-separated. | (optional) defaults to undefined|
+| **includeDeleted** | [**boolean**] | Include soft-deleted profiles in the results. Defaults to false. | (optional) defaults to false|
 
 
 ### Return type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestbox-ai/doc-processing-api",
-  "version": "1.0.69",
+  "version": "1.0.71",
   "description": "OpenAPI client for @nestbox-ai/doc-processing-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {