@nestbox-ai/doc-processing-api 1.0.70 → 1.0.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/api.ts +87 -7
- package/dist/api.d.ts +44 -4
- package/dist/api.js +80 -7
- package/dist/esm/api.d.ts +44 -4
- package/dist/esm/api.js +80 -7
- package/docs/ProfileDto.md +2 -0
- package/docs/ProfilesApi.md +58 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @nestbox-ai/doc-processing-api@1.0.
|
|
1
|
+
## @nestbox-ai/doc-processing-api@1.0.71
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @nestbox-ai/doc-processing-api@1.0.
|
|
39
|
+
npm install @nestbox-ai/doc-processing-api@1.0.71 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -64,6 +64,7 @@ Class | Method | HTTP request | Description
|
|
|
64
64
|
*JobsApi* | [**jobsControllerGetJobStatus**](docs/JobsApi.md#jobscontrollergetjobstatus) | **GET** /jobs/{jobId}/status | Get job status
|
|
65
65
|
*JobsApi* | [**jobsControllerListJobs**](docs/JobsApi.md#jobscontrollerlistjobs) | **GET** /jobs | List jobs
|
|
66
66
|
*ProfilesApi* | [**profilesControllerCreateProfile**](docs/ProfilesApi.md#profilescontrollercreateprofile) | **POST** /profiles | Create profile from YAML
|
|
67
|
+
*ProfilesApi* | [**profilesControllerDeleteProfile**](docs/ProfilesApi.md#profilescontrollerdeleteprofile) | **DELETE** /profiles/{profileId} | Delete profile
|
|
67
68
|
*ProfilesApi* | [**profilesControllerGetProfile**](docs/ProfilesApi.md#profilescontrollergetprofile) | **GET** /profiles/{profileId} | Read profile
|
|
68
69
|
*ProfilesApi* | [**profilesControllerGetProfileSchema**](docs/ProfilesApi.md#profilescontrollergetprofileschema) | **GET** /profiles/schema | Get profile schema
|
|
69
70
|
*ProfilesApi* | [**profilesControllerListProfiles**](docs/ProfilesApi.md#profilescontrollerlistprofiles) | **GET** /profiles | List profiles
|
package/api.ts
CHANGED
|
@@ -562,6 +562,10 @@ export interface ProfileDto {
|
|
|
562
562
|
* Profile last update timestamp
|
|
563
563
|
*/
|
|
564
564
|
'updatedAt'?: string;
|
|
565
|
+
/**
|
|
566
|
+
* Profile soft-deletion timestamp
|
|
567
|
+
*/
|
|
568
|
+
'deletedAt'?: string;
|
|
565
569
|
/**
|
|
566
570
|
* YAML file name
|
|
567
571
|
*/
|
|
@@ -1876,6 +1880,40 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1876
1880
|
options: localVarRequestOptions,
|
|
1877
1881
|
};
|
|
1878
1882
|
},
|
|
1883
|
+
/**
|
|
1884
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1885
|
+
* @summary Delete profile
|
|
1886
|
+
* @param {string} profileId Profile/config ID.
|
|
1887
|
+
* @param {*} [options] Override http request option.
|
|
1888
|
+
* @throws {RequiredError}
|
|
1889
|
+
*/
|
|
1890
|
+
profilesControllerDeleteProfile: async (profileId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1891
|
+
// verify required parameter 'profileId' is not null or undefined
|
|
1892
|
+
assertParamExists('profilesControllerDeleteProfile', 'profileId', profileId)
|
|
1893
|
+
const localVarPath = `/profiles/{profileId}`
|
|
1894
|
+
.replace(`{${"profileId"}}`, encodeURIComponent(String(profileId)));
|
|
1895
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1896
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1897
|
+
let baseOptions;
|
|
1898
|
+
if (configuration) {
|
|
1899
|
+
baseOptions = configuration.baseOptions;
|
|
1900
|
+
}
|
|
1901
|
+
|
|
1902
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1903
|
+
const localVarHeaderParameter = {} as any;
|
|
1904
|
+
const localVarQueryParameter = {} as any;
|
|
1905
|
+
|
|
1906
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1907
|
+
|
|
1908
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1909
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1910
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1911
|
+
|
|
1912
|
+
return {
|
|
1913
|
+
url: toPathString(localVarUrlObj),
|
|
1914
|
+
options: localVarRequestOptions,
|
|
1915
|
+
};
|
|
1916
|
+
},
|
|
1879
1917
|
/**
|
|
1880
1918
|
*
|
|
1881
1919
|
* @summary Read profile
|
|
@@ -1946,10 +1984,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1946
1984
|
* @param {number} [page] 1-based page number.
|
|
1947
1985
|
* @param {number} [limit] Page size.
|
|
1948
1986
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1987
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1949
1988
|
* @param {*} [options] Override http request option.
|
|
1950
1989
|
* @throws {RequiredError}
|
|
1951
1990
|
*/
|
|
1952
|
-
profilesControllerListProfiles: async (page?: number, limit?: number, tags?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1991
|
+
profilesControllerListProfiles: async (page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1953
1992
|
const localVarPath = `/profiles`;
|
|
1954
1993
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1955
1994
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1974,6 +2013,10 @@ export const ProfilesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1974
2013
|
localVarQueryParameter['tags'] = tags;
|
|
1975
2014
|
}
|
|
1976
2015
|
|
|
2016
|
+
if (includeDeleted !== undefined) {
|
|
2017
|
+
localVarQueryParameter['includeDeleted'] = includeDeleted;
|
|
2018
|
+
}
|
|
2019
|
+
|
|
1977
2020
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1978
2021
|
|
|
1979
2022
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2009,6 +2052,19 @@ export const ProfilesApiFp = function(configuration?: Configuration) {
|
|
|
2009
2052
|
const localVarOperationServerBasePath = operationServerMap['ProfilesApi.profilesControllerCreateProfile']?.[localVarOperationServerIndex]?.url;
|
|
2010
2053
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2011
2054
|
},
|
|
2055
|
+
/**
|
|
2056
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
2057
|
+
* @summary Delete profile
|
|
2058
|
+
* @param {string} profileId Profile/config ID.
|
|
2059
|
+
* @param {*} [options] Override http request option.
|
|
2060
|
+
* @throws {RequiredError}
|
|
2061
|
+
*/
|
|
2062
|
+
async profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>> {
|
|
2063
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerDeleteProfile(profileId, options);
|
|
2064
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2065
|
+
const localVarOperationServerBasePath = operationServerMap['ProfilesApi.profilesControllerDeleteProfile']?.[localVarOperationServerIndex]?.url;
|
|
2066
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2067
|
+
},
|
|
2012
2068
|
/**
|
|
2013
2069
|
*
|
|
2014
2070
|
* @summary Read profile
|
|
@@ -2040,11 +2096,12 @@ export const ProfilesApiFp = function(configuration?: Configuration) {
|
|
|
2040
2096
|
* @param {number} [page] 1-based page number.
|
|
2041
2097
|
* @param {number} [limit] Page size.
|
|
2042
2098
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
2099
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
2043
2100
|
* @param {*} [options] Override http request option.
|
|
2044
2101
|
* @throws {RequiredError}
|
|
2045
2102
|
*/
|
|
2046
|
-
async profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>> {
|
|
2047
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
|
|
2103
|
+
async profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>> {
|
|
2104
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, includeDeleted, options);
|
|
2048
2105
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2049
2106
|
const localVarOperationServerBasePath = operationServerMap['ProfilesApi.profilesControllerListProfiles']?.[localVarOperationServerIndex]?.url;
|
|
2050
2107
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2070,6 +2127,16 @@ export const ProfilesApiFactory = function (configuration?: Configuration, baseP
|
|
|
2070
2127
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto> {
|
|
2071
2128
|
return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
|
|
2072
2129
|
},
|
|
2130
|
+
/**
|
|
2131
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
2132
|
+
* @summary Delete profile
|
|
2133
|
+
* @param {string} profileId Profile/config ID.
|
|
2134
|
+
* @param {*} [options] Override http request option.
|
|
2135
|
+
* @throws {RequiredError}
|
|
2136
|
+
*/
|
|
2137
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto> {
|
|
2138
|
+
return localVarFp.profilesControllerDeleteProfile(profileId, options).then((request) => request(axios, basePath));
|
|
2139
|
+
},
|
|
2073
2140
|
/**
|
|
2074
2141
|
*
|
|
2075
2142
|
* @summary Read profile
|
|
@@ -2095,11 +2162,12 @@ export const ProfilesApiFactory = function (configuration?: Configuration, baseP
|
|
|
2095
2162
|
* @param {number} [page] 1-based page number.
|
|
2096
2163
|
* @param {number} [limit] Page size.
|
|
2097
2164
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
2165
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
2098
2166
|
* @param {*} [options] Override http request option.
|
|
2099
2167
|
* @throws {RequiredError}
|
|
2100
2168
|
*/
|
|
2101
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto> {
|
|
2102
|
-
return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
|
|
2169
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto> {
|
|
2170
|
+
return localVarFp.profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(axios, basePath));
|
|
2103
2171
|
},
|
|
2104
2172
|
};
|
|
2105
2173
|
};
|
|
@@ -2121,6 +2189,17 @@ export class ProfilesApi extends BaseAPI {
|
|
|
2121
2189
|
return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
|
|
2122
2190
|
}
|
|
2123
2191
|
|
|
2192
|
+
/**
|
|
2193
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
2194
|
+
* @summary Delete profile
|
|
2195
|
+
* @param {string} profileId Profile/config ID.
|
|
2196
|
+
* @param {*} [options] Override http request option.
|
|
2197
|
+
* @throws {RequiredError}
|
|
2198
|
+
*/
|
|
2199
|
+
public profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig) {
|
|
2200
|
+
return ProfilesApiFp(this.configuration).profilesControllerDeleteProfile(profileId, options).then((request) => request(this.axios, this.basePath));
|
|
2201
|
+
}
|
|
2202
|
+
|
|
2124
2203
|
/**
|
|
2125
2204
|
*
|
|
2126
2205
|
* @summary Read profile
|
|
@@ -2148,11 +2227,12 @@ export class ProfilesApi extends BaseAPI {
|
|
|
2148
2227
|
* @param {number} [page] 1-based page number.
|
|
2149
2228
|
* @param {number} [limit] Page size.
|
|
2150
2229
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
2230
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
2151
2231
|
* @param {*} [options] Override http request option.
|
|
2152
2232
|
* @throws {RequiredError}
|
|
2153
2233
|
*/
|
|
2154
|
-
public profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) {
|
|
2155
|
-
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
|
|
2234
|
+
public profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig) {
|
|
2235
|
+
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(this.axios, this.basePath));
|
|
2156
2236
|
}
|
|
2157
2237
|
}
|
|
2158
2238
|
|
package/dist/api.d.ts
CHANGED
|
@@ -541,6 +541,10 @@ export interface ProfileDto {
|
|
|
541
541
|
* Profile last update timestamp
|
|
542
542
|
*/
|
|
543
543
|
'updatedAt'?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Profile soft-deletion timestamp
|
|
546
|
+
*/
|
|
547
|
+
'deletedAt'?: string;
|
|
544
548
|
/**
|
|
545
549
|
* YAML file name
|
|
546
550
|
*/
|
|
@@ -1237,6 +1241,14 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1237
1241
|
* @throws {RequiredError}
|
|
1238
1242
|
*/
|
|
1239
1243
|
profilesControllerCreateProfile: (yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1244
|
+
/**
|
|
1245
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1246
|
+
* @summary Delete profile
|
|
1247
|
+
* @param {string} profileId Profile/config ID.
|
|
1248
|
+
* @param {*} [options] Override http request option.
|
|
1249
|
+
* @throws {RequiredError}
|
|
1250
|
+
*/
|
|
1251
|
+
profilesControllerDeleteProfile: (profileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1240
1252
|
/**
|
|
1241
1253
|
*
|
|
1242
1254
|
* @summary Read profile
|
|
@@ -1258,10 +1270,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1258
1270
|
* @param {number} [page] 1-based page number.
|
|
1259
1271
|
* @param {number} [limit] Page size.
|
|
1260
1272
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1273
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1261
1274
|
* @param {*} [options] Override http request option.
|
|
1262
1275
|
* @throws {RequiredError}
|
|
1263
1276
|
*/
|
|
1264
|
-
profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1277
|
+
profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1265
1278
|
};
|
|
1266
1279
|
/**
|
|
1267
1280
|
* ProfilesApi - functional programming interface
|
|
@@ -1277,6 +1290,14 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1277
1290
|
* @throws {RequiredError}
|
|
1278
1291
|
*/
|
|
1279
1292
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1295
|
+
* @summary Delete profile
|
|
1296
|
+
* @param {string} profileId Profile/config ID.
|
|
1297
|
+
* @param {*} [options] Override http request option.
|
|
1298
|
+
* @throws {RequiredError}
|
|
1299
|
+
*/
|
|
1300
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1280
1301
|
/**
|
|
1281
1302
|
*
|
|
1282
1303
|
* @summary Read profile
|
|
@@ -1300,10 +1321,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1300
1321
|
* @param {number} [page] 1-based page number.
|
|
1301
1322
|
* @param {number} [limit] Page size.
|
|
1302
1323
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1324
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1303
1325
|
* @param {*} [options] Override http request option.
|
|
1304
1326
|
* @throws {RequiredError}
|
|
1305
1327
|
*/
|
|
1306
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
|
|
1328
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
|
|
1307
1329
|
};
|
|
1308
1330
|
/**
|
|
1309
1331
|
* ProfilesApi - factory interface
|
|
@@ -1319,6 +1341,14 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
|
|
|
1319
1341
|
* @throws {RequiredError}
|
|
1320
1342
|
*/
|
|
1321
1343
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1346
|
+
* @summary Delete profile
|
|
1347
|
+
* @param {string} profileId Profile/config ID.
|
|
1348
|
+
* @param {*} [options] Override http request option.
|
|
1349
|
+
* @throws {RequiredError}
|
|
1350
|
+
*/
|
|
1351
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1322
1352
|
/**
|
|
1323
1353
|
*
|
|
1324
1354
|
* @summary Read profile
|
|
@@ -1342,10 +1372,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
|
|
|
1342
1372
|
* @param {number} [page] 1-based page number.
|
|
1343
1373
|
* @param {number} [limit] Page size.
|
|
1344
1374
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1375
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1345
1376
|
* @param {*} [options] Override http request option.
|
|
1346
1377
|
* @throws {RequiredError}
|
|
1347
1378
|
*/
|
|
1348
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
|
|
1379
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
|
|
1349
1380
|
};
|
|
1350
1381
|
/**
|
|
1351
1382
|
* ProfilesApi - object-oriented interface
|
|
@@ -1361,6 +1392,14 @@ export declare class ProfilesApi extends BaseAPI {
|
|
|
1361
1392
|
* @throws {RequiredError}
|
|
1362
1393
|
*/
|
|
1363
1394
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1397
|
+
* @summary Delete profile
|
|
1398
|
+
* @param {string} profileId Profile/config ID.
|
|
1399
|
+
* @param {*} [options] Override http request option.
|
|
1400
|
+
* @throws {RequiredError}
|
|
1401
|
+
*/
|
|
1402
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1364
1403
|
/**
|
|
1365
1404
|
*
|
|
1366
1405
|
* @summary Read profile
|
|
@@ -1384,10 +1423,11 @@ export declare class ProfilesApi extends BaseAPI {
|
|
|
1384
1423
|
* @param {number} [page] 1-based page number.
|
|
1385
1424
|
* @param {number} [limit] Page size.
|
|
1386
1425
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1426
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1387
1427
|
* @param {*} [options] Override http request option.
|
|
1388
1428
|
* @throws {RequiredError}
|
|
1389
1429
|
*/
|
|
1390
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
|
|
1430
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
|
|
1391
1431
|
}
|
|
1392
1432
|
/**
|
|
1393
1433
|
* QueriesApi - axios parameter creator
|
package/dist/api.js
CHANGED
|
@@ -1211,6 +1211,36 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1211
1211
|
options: localVarRequestOptions,
|
|
1212
1212
|
};
|
|
1213
1213
|
}),
|
|
1214
|
+
/**
|
|
1215
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1216
|
+
* @summary Delete profile
|
|
1217
|
+
* @param {string} profileId Profile/config ID.
|
|
1218
|
+
* @param {*} [options] Override http request option.
|
|
1219
|
+
* @throws {RequiredError}
|
|
1220
|
+
*/
|
|
1221
|
+
profilesControllerDeleteProfile: (profileId_1, ...args_1) => __awaiter(this, [profileId_1, ...args_1], void 0, function* (profileId, options = {}) {
|
|
1222
|
+
// verify required parameter 'profileId' is not null or undefined
|
|
1223
|
+
(0, common_1.assertParamExists)('profilesControllerDeleteProfile', 'profileId', profileId);
|
|
1224
|
+
const localVarPath = `/profiles/{profileId}`
|
|
1225
|
+
.replace(`{${"profileId"}}`, encodeURIComponent(String(profileId)));
|
|
1226
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1227
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1228
|
+
let baseOptions;
|
|
1229
|
+
if (configuration) {
|
|
1230
|
+
baseOptions = configuration.baseOptions;
|
|
1231
|
+
}
|
|
1232
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1233
|
+
const localVarHeaderParameter = {};
|
|
1234
|
+
const localVarQueryParameter = {};
|
|
1235
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1236
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1237
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1238
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1239
|
+
return {
|
|
1240
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1241
|
+
options: localVarRequestOptions,
|
|
1242
|
+
};
|
|
1243
|
+
}),
|
|
1214
1244
|
/**
|
|
1215
1245
|
*
|
|
1216
1246
|
* @summary Read profile
|
|
@@ -1273,10 +1303,11 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1273
1303
|
* @param {number} [page] 1-based page number.
|
|
1274
1304
|
* @param {number} [limit] Page size.
|
|
1275
1305
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1306
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1276
1307
|
* @param {*} [options] Override http request option.
|
|
1277
1308
|
* @throws {RequiredError}
|
|
1278
1309
|
*/
|
|
1279
|
-
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 = {}) {
|
|
1310
|
+
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 = {}) {
|
|
1280
1311
|
const localVarPath = `/profiles`;
|
|
1281
1312
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1282
1313
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -1296,6 +1327,9 @@ const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1296
1327
|
if (tags) {
|
|
1297
1328
|
localVarQueryParameter['tags'] = tags;
|
|
1298
1329
|
}
|
|
1330
|
+
if (includeDeleted !== undefined) {
|
|
1331
|
+
localVarQueryParameter['includeDeleted'] = includeDeleted;
|
|
1332
|
+
}
|
|
1299
1333
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1300
1334
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1301
1335
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1332,6 +1366,22 @@ const ProfilesApiFp = function (configuration) {
|
|
|
1332
1366
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1333
1367
|
});
|
|
1334
1368
|
},
|
|
1369
|
+
/**
|
|
1370
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1371
|
+
* @summary Delete profile
|
|
1372
|
+
* @param {string} profileId Profile/config ID.
|
|
1373
|
+
* @param {*} [options] Override http request option.
|
|
1374
|
+
* @throws {RequiredError}
|
|
1375
|
+
*/
|
|
1376
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1377
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1378
|
+
var _a, _b, _c;
|
|
1379
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerDeleteProfile(profileId, options);
|
|
1380
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1381
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProfilesApi.profilesControllerDeleteProfile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1382
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1383
|
+
});
|
|
1384
|
+
},
|
|
1335
1385
|
/**
|
|
1336
1386
|
*
|
|
1337
1387
|
* @summary Read profile
|
|
@@ -1369,13 +1419,14 @@ const ProfilesApiFp = function (configuration) {
|
|
|
1369
1419
|
* @param {number} [page] 1-based page number.
|
|
1370
1420
|
* @param {number} [limit] Page size.
|
|
1371
1421
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1422
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1372
1423
|
* @param {*} [options] Override http request option.
|
|
1373
1424
|
* @throws {RequiredError}
|
|
1374
1425
|
*/
|
|
1375
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1426
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1376
1427
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1377
1428
|
var _a, _b, _c;
|
|
1378
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
|
|
1429
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, includeDeleted, options);
|
|
1379
1430
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1380
1431
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProfilesApi.profilesControllerListProfiles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1381
1432
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1402,6 +1453,16 @@ const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1402
1453
|
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1403
1454
|
return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
|
|
1404
1455
|
},
|
|
1456
|
+
/**
|
|
1457
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1458
|
+
* @summary Delete profile
|
|
1459
|
+
* @param {string} profileId Profile/config ID.
|
|
1460
|
+
* @param {*} [options] Override http request option.
|
|
1461
|
+
* @throws {RequiredError}
|
|
1462
|
+
*/
|
|
1463
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1464
|
+
return localVarFp.profilesControllerDeleteProfile(profileId, options).then((request) => request(axios, basePath));
|
|
1465
|
+
},
|
|
1405
1466
|
/**
|
|
1406
1467
|
*
|
|
1407
1468
|
* @summary Read profile
|
|
@@ -1427,11 +1488,12 @@ const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1427
1488
|
* @param {number} [page] 1-based page number.
|
|
1428
1489
|
* @param {number} [limit] Page size.
|
|
1429
1490
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1491
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1430
1492
|
* @param {*} [options] Override http request option.
|
|
1431
1493
|
* @throws {RequiredError}
|
|
1432
1494
|
*/
|
|
1433
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1434
|
-
return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
|
|
1495
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1496
|
+
return localVarFp.profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(axios, basePath));
|
|
1435
1497
|
},
|
|
1436
1498
|
};
|
|
1437
1499
|
};
|
|
@@ -1452,6 +1514,16 @@ class ProfilesApi extends base_1.BaseAPI {
|
|
|
1452
1514
|
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1453
1515
|
return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1454
1516
|
}
|
|
1517
|
+
/**
|
|
1518
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1519
|
+
* @summary Delete profile
|
|
1520
|
+
* @param {string} profileId Profile/config ID.
|
|
1521
|
+
* @param {*} [options] Override http request option.
|
|
1522
|
+
* @throws {RequiredError}
|
|
1523
|
+
*/
|
|
1524
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1525
|
+
return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerDeleteProfile(profileId, options).then((request) => request(this.axios, this.basePath));
|
|
1526
|
+
}
|
|
1455
1527
|
/**
|
|
1456
1528
|
*
|
|
1457
1529
|
* @summary Read profile
|
|
@@ -1477,11 +1549,12 @@ class ProfilesApi extends base_1.BaseAPI {
|
|
|
1477
1549
|
* @param {number} [page] 1-based page number.
|
|
1478
1550
|
* @param {number} [limit] Page size.
|
|
1479
1551
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1552
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1480
1553
|
* @param {*} [options] Override http request option.
|
|
1481
1554
|
* @throws {RequiredError}
|
|
1482
1555
|
*/
|
|
1483
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1484
|
-
return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1556
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1557
|
+
return (0, exports.ProfilesApiFp)(this.configuration).profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(this.axios, this.basePath));
|
|
1485
1558
|
}
|
|
1486
1559
|
}
|
|
1487
1560
|
exports.ProfilesApi = ProfilesApi;
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -541,6 +541,10 @@ export interface ProfileDto {
|
|
|
541
541
|
* Profile last update timestamp
|
|
542
542
|
*/
|
|
543
543
|
'updatedAt'?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Profile soft-deletion timestamp
|
|
546
|
+
*/
|
|
547
|
+
'deletedAt'?: string;
|
|
544
548
|
/**
|
|
545
549
|
* YAML file name
|
|
546
550
|
*/
|
|
@@ -1237,6 +1241,14 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1237
1241
|
* @throws {RequiredError}
|
|
1238
1242
|
*/
|
|
1239
1243
|
profilesControllerCreateProfile: (yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1244
|
+
/**
|
|
1245
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1246
|
+
* @summary Delete profile
|
|
1247
|
+
* @param {string} profileId Profile/config ID.
|
|
1248
|
+
* @param {*} [options] Override http request option.
|
|
1249
|
+
* @throws {RequiredError}
|
|
1250
|
+
*/
|
|
1251
|
+
profilesControllerDeleteProfile: (profileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1240
1252
|
/**
|
|
1241
1253
|
*
|
|
1242
1254
|
* @summary Read profile
|
|
@@ -1258,10 +1270,11 @@ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1258
1270
|
* @param {number} [page] 1-based page number.
|
|
1259
1271
|
* @param {number} [limit] Page size.
|
|
1260
1272
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1273
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1261
1274
|
* @param {*} [options] Override http request option.
|
|
1262
1275
|
* @throws {RequiredError}
|
|
1263
1276
|
*/
|
|
1264
|
-
profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1277
|
+
profilesControllerListProfiles: (page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1265
1278
|
};
|
|
1266
1279
|
/**
|
|
1267
1280
|
* ProfilesApi - functional programming interface
|
|
@@ -1277,6 +1290,14 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1277
1290
|
* @throws {RequiredError}
|
|
1278
1291
|
*/
|
|
1279
1292
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1295
|
+
* @summary Delete profile
|
|
1296
|
+
* @param {string} profileId Profile/config ID.
|
|
1297
|
+
* @param {*} [options] Override http request option.
|
|
1298
|
+
* @throws {RequiredError}
|
|
1299
|
+
*/
|
|
1300
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfileDto>>;
|
|
1280
1301
|
/**
|
|
1281
1302
|
*
|
|
1282
1303
|
* @summary Read profile
|
|
@@ -1300,10 +1321,11 @@ export declare const ProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1300
1321
|
* @param {number} [page] 1-based page number.
|
|
1301
1322
|
* @param {number} [limit] Page size.
|
|
1302
1323
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1324
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1303
1325
|
* @param {*} [options] Override http request option.
|
|
1304
1326
|
* @throws {RequiredError}
|
|
1305
1327
|
*/
|
|
1306
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
|
|
1328
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedProfilesDto>>;
|
|
1307
1329
|
};
|
|
1308
1330
|
/**
|
|
1309
1331
|
* ProfilesApi - factory interface
|
|
@@ -1319,6 +1341,14 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
|
|
|
1319
1341
|
* @throws {RequiredError}
|
|
1320
1342
|
*/
|
|
1321
1343
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1346
|
+
* @summary Delete profile
|
|
1347
|
+
* @param {string} profileId Profile/config ID.
|
|
1348
|
+
* @param {*} [options] Override http request option.
|
|
1349
|
+
* @throws {RequiredError}
|
|
1350
|
+
*/
|
|
1351
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfileDto>;
|
|
1322
1352
|
/**
|
|
1323
1353
|
*
|
|
1324
1354
|
* @summary Read profile
|
|
@@ -1342,10 +1372,11 @@ export declare const ProfilesApiFactory: (configuration?: Configuration, basePat
|
|
|
1342
1372
|
* @param {number} [page] 1-based page number.
|
|
1343
1373
|
* @param {number} [limit] Page size.
|
|
1344
1374
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1375
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1345
1376
|
* @param {*} [options] Override http request option.
|
|
1346
1377
|
* @throws {RequiredError}
|
|
1347
1378
|
*/
|
|
1348
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
|
|
1379
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedProfilesDto>;
|
|
1349
1380
|
};
|
|
1350
1381
|
/**
|
|
1351
1382
|
* ProfilesApi - object-oriented interface
|
|
@@ -1361,6 +1392,14 @@ export declare class ProfilesApi extends BaseAPI {
|
|
|
1361
1392
|
* @throws {RequiredError}
|
|
1362
1393
|
*/
|
|
1363
1394
|
profilesControllerCreateProfile(yaml: File, name?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1397
|
+
* @summary Delete profile
|
|
1398
|
+
* @param {string} profileId Profile/config ID.
|
|
1399
|
+
* @param {*} [options] Override http request option.
|
|
1400
|
+
* @throws {RequiredError}
|
|
1401
|
+
*/
|
|
1402
|
+
profilesControllerDeleteProfile(profileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfileDto, any, {}>>;
|
|
1364
1403
|
/**
|
|
1365
1404
|
*
|
|
1366
1405
|
* @summary Read profile
|
|
@@ -1384,10 +1423,11 @@ export declare class ProfilesApi extends BaseAPI {
|
|
|
1384
1423
|
* @param {number} [page] 1-based page number.
|
|
1385
1424
|
* @param {number} [limit] Page size.
|
|
1386
1425
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1426
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1387
1427
|
* @param {*} [options] Override http request option.
|
|
1388
1428
|
* @throws {RequiredError}
|
|
1389
1429
|
*/
|
|
1390
|
-
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
|
|
1430
|
+
profilesControllerListProfiles(page?: number, limit?: number, tags?: Array<string>, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedProfilesDto, any, {}>>;
|
|
1391
1431
|
}
|
|
1392
1432
|
/**
|
|
1393
1433
|
* QueriesApi - axios parameter creator
|
package/dist/esm/api.js
CHANGED
|
@@ -1188,6 +1188,36 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1188
1188
|
options: localVarRequestOptions,
|
|
1189
1189
|
};
|
|
1190
1190
|
}),
|
|
1191
|
+
/**
|
|
1192
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1193
|
+
* @summary Delete profile
|
|
1194
|
+
* @param {string} profileId Profile/config ID.
|
|
1195
|
+
* @param {*} [options] Override http request option.
|
|
1196
|
+
* @throws {RequiredError}
|
|
1197
|
+
*/
|
|
1198
|
+
profilesControllerDeleteProfile: (profileId_1, ...args_1) => __awaiter(this, [profileId_1, ...args_1], void 0, function* (profileId, options = {}) {
|
|
1199
|
+
// verify required parameter 'profileId' is not null or undefined
|
|
1200
|
+
assertParamExists('profilesControllerDeleteProfile', 'profileId', profileId);
|
|
1201
|
+
const localVarPath = `/profiles/{profileId}`
|
|
1202
|
+
.replace(`{${"profileId"}}`, encodeURIComponent(String(profileId)));
|
|
1203
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1204
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1205
|
+
let baseOptions;
|
|
1206
|
+
if (configuration) {
|
|
1207
|
+
baseOptions = configuration.baseOptions;
|
|
1208
|
+
}
|
|
1209
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1210
|
+
const localVarHeaderParameter = {};
|
|
1211
|
+
const localVarQueryParameter = {};
|
|
1212
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1213
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1214
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1215
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1216
|
+
return {
|
|
1217
|
+
url: toPathString(localVarUrlObj),
|
|
1218
|
+
options: localVarRequestOptions,
|
|
1219
|
+
};
|
|
1220
|
+
}),
|
|
1191
1221
|
/**
|
|
1192
1222
|
*
|
|
1193
1223
|
* @summary Read profile
|
|
@@ -1250,10 +1280,11 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1250
1280
|
* @param {number} [page] 1-based page number.
|
|
1251
1281
|
* @param {number} [limit] Page size.
|
|
1252
1282
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1283
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1253
1284
|
* @param {*} [options] Override http request option.
|
|
1254
1285
|
* @throws {RequiredError}
|
|
1255
1286
|
*/
|
|
1256
|
-
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 = {}) {
|
|
1287
|
+
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 = {}) {
|
|
1257
1288
|
const localVarPath = `/profiles`;
|
|
1258
1289
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1259
1290
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1273,6 +1304,9 @@ export const ProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
1273
1304
|
if (tags) {
|
|
1274
1305
|
localVarQueryParameter['tags'] = tags;
|
|
1275
1306
|
}
|
|
1307
|
+
if (includeDeleted !== undefined) {
|
|
1308
|
+
localVarQueryParameter['includeDeleted'] = includeDeleted;
|
|
1309
|
+
}
|
|
1276
1310
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1277
1311
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1278
1312
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1308,6 +1342,22 @@ export const ProfilesApiFp = function (configuration) {
|
|
|
1308
1342
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1309
1343
|
});
|
|
1310
1344
|
},
|
|
1345
|
+
/**
|
|
1346
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1347
|
+
* @summary Delete profile
|
|
1348
|
+
* @param {string} profileId Profile/config ID.
|
|
1349
|
+
* @param {*} [options] Override http request option.
|
|
1350
|
+
* @throws {RequiredError}
|
|
1351
|
+
*/
|
|
1352
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1353
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1354
|
+
var _a, _b, _c;
|
|
1355
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerDeleteProfile(profileId, options);
|
|
1356
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1357
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerDeleteProfile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1358
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1359
|
+
});
|
|
1360
|
+
},
|
|
1311
1361
|
/**
|
|
1312
1362
|
*
|
|
1313
1363
|
* @summary Read profile
|
|
@@ -1345,13 +1395,14 @@ export const ProfilesApiFp = function (configuration) {
|
|
|
1345
1395
|
* @param {number} [page] 1-based page number.
|
|
1346
1396
|
* @param {number} [limit] Page size.
|
|
1347
1397
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1398
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1348
1399
|
* @param {*} [options] Override http request option.
|
|
1349
1400
|
* @throws {RequiredError}
|
|
1350
1401
|
*/
|
|
1351
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1402
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1352
1403
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1353
1404
|
var _a, _b, _c;
|
|
1354
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, options);
|
|
1405
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.profilesControllerListProfiles(page, limit, tags, includeDeleted, options);
|
|
1355
1406
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1356
1407
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProfilesApi.profilesControllerListProfiles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1357
1408
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1377,6 +1428,16 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1377
1428
|
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1378
1429
|
return localVarFp.profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(axios, basePath));
|
|
1379
1430
|
},
|
|
1431
|
+
/**
|
|
1432
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1433
|
+
* @summary Delete profile
|
|
1434
|
+
* @param {string} profileId Profile/config ID.
|
|
1435
|
+
* @param {*} [options] Override http request option.
|
|
1436
|
+
* @throws {RequiredError}
|
|
1437
|
+
*/
|
|
1438
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1439
|
+
return localVarFp.profilesControllerDeleteProfile(profileId, options).then((request) => request(axios, basePath));
|
|
1440
|
+
},
|
|
1380
1441
|
/**
|
|
1381
1442
|
*
|
|
1382
1443
|
* @summary Read profile
|
|
@@ -1402,11 +1463,12 @@ export const ProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
1402
1463
|
* @param {number} [page] 1-based page number.
|
|
1403
1464
|
* @param {number} [limit] Page size.
|
|
1404
1465
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1466
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1405
1467
|
* @param {*} [options] Override http request option.
|
|
1406
1468
|
* @throws {RequiredError}
|
|
1407
1469
|
*/
|
|
1408
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1409
|
-
return localVarFp.profilesControllerListProfiles(page, limit, tags, options).then((request) => request(axios, basePath));
|
|
1470
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1471
|
+
return localVarFp.profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(axios, basePath));
|
|
1410
1472
|
},
|
|
1411
1473
|
};
|
|
1412
1474
|
};
|
|
@@ -1426,6 +1488,16 @@ export class ProfilesApi extends BaseAPI {
|
|
|
1426
1488
|
profilesControllerCreateProfile(yaml, name, tags, options) {
|
|
1427
1489
|
return ProfilesApiFp(this.configuration).profilesControllerCreateProfile(yaml, name, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1428
1490
|
}
|
|
1491
|
+
/**
|
|
1492
|
+
* Soft-deletes a profile by setting its deletedAt timestamp.
|
|
1493
|
+
* @summary Delete profile
|
|
1494
|
+
* @param {string} profileId Profile/config ID.
|
|
1495
|
+
* @param {*} [options] Override http request option.
|
|
1496
|
+
* @throws {RequiredError}
|
|
1497
|
+
*/
|
|
1498
|
+
profilesControllerDeleteProfile(profileId, options) {
|
|
1499
|
+
return ProfilesApiFp(this.configuration).profilesControllerDeleteProfile(profileId, options).then((request) => request(this.axios, this.basePath));
|
|
1500
|
+
}
|
|
1429
1501
|
/**
|
|
1430
1502
|
*
|
|
1431
1503
|
* @summary Read profile
|
|
@@ -1451,11 +1523,12 @@ export class ProfilesApi extends BaseAPI {
|
|
|
1451
1523
|
* @param {number} [page] 1-based page number.
|
|
1452
1524
|
* @param {number} [limit] Page size.
|
|
1453
1525
|
* @param {Array<string>} [tags] Filter profiles by tags (any match). Pass multiple times or comma-separated.
|
|
1526
|
+
* @param {boolean} [includeDeleted] Include soft-deleted profiles in the results. Defaults to false.
|
|
1454
1527
|
* @param {*} [options] Override http request option.
|
|
1455
1528
|
* @throws {RequiredError}
|
|
1456
1529
|
*/
|
|
1457
|
-
profilesControllerListProfiles(page, limit, tags, options) {
|
|
1458
|
-
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, options).then((request) => request(this.axios, this.basePath));
|
|
1530
|
+
profilesControllerListProfiles(page, limit, tags, includeDeleted, options) {
|
|
1531
|
+
return ProfilesApiFp(this.configuration).profilesControllerListProfiles(page, limit, tags, includeDeleted, options).then((request) => request(this.axios, this.basePath));
|
|
1459
1532
|
}
|
|
1460
1533
|
}
|
|
1461
1534
|
/**
|
package/docs/ProfileDto.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**description** | **string** | Profile description | [optional] [default to undefined]
|
|
11
11
|
**createdAt** | **string** | Profile creation timestamp | [default to undefined]
|
|
12
12
|
**updatedAt** | **string** | Profile last update timestamp | [optional] [default to undefined]
|
|
13
|
+
**deletedAt** | **string** | Profile soft-deletion timestamp | [optional] [default to undefined]
|
|
13
14
|
**yamlFileName** | **string** | YAML file name | [optional] [default to undefined]
|
|
14
15
|
**yamlSha256** | **string** | Optional checksum of the uploaded YAML file | [optional] [default to undefined]
|
|
15
16
|
**yamlFileContent** | **string** | Content of the YAML file | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ const instance: ProfileDto = {
|
|
|
26
27
|
description,
|
|
27
28
|
createdAt,
|
|
28
29
|
updatedAt,
|
|
30
|
+
deletedAt,
|
|
29
31
|
yamlFileName,
|
|
30
32
|
yamlSha256,
|
|
31
33
|
yamlFileContent,
|
package/docs/ProfilesApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**profilesControllerCreateProfile**](#profilescontrollercreateprofile) | **POST** /profiles | Create profile from YAML|
|
|
8
|
+
|[**profilesControllerDeleteProfile**](#profilescontrollerdeleteprofile) | **DELETE** /profiles/{profileId} | Delete profile|
|
|
8
9
|
|[**profilesControllerGetProfile**](#profilescontrollergetprofile) | **GET** /profiles/{profileId} | Read profile|
|
|
9
10
|
|[**profilesControllerGetProfileSchema**](#profilescontrollergetprofileschema) | **GET** /profiles/schema | Get profile schema|
|
|
10
11
|
|[**profilesControllerListProfiles**](#profilescontrollerlistprofiles) | **GET** /profiles | List profiles|
|
|
@@ -69,6 +70,59 @@ No authorization required
|
|
|
69
70
|
|
|
70
71
|
[[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)
|
|
71
72
|
|
|
73
|
+
# **profilesControllerDeleteProfile**
|
|
74
|
+
> ProfileDto profilesControllerDeleteProfile()
|
|
75
|
+
|
|
76
|
+
Soft-deletes a profile by setting its deletedAt timestamp.
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
ProfilesApi,
|
|
83
|
+
Configuration
|
|
84
|
+
} from '@nestbox-ai/doc-processing-api';
|
|
85
|
+
|
|
86
|
+
const configuration = new Configuration();
|
|
87
|
+
const apiInstance = new ProfilesApi(configuration);
|
|
88
|
+
|
|
89
|
+
let profileId: string; //Profile/config ID. (default to undefined)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.profilesControllerDeleteProfile(
|
|
92
|
+
profileId
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **profileId** | [**string**] | Profile/config ID. | defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**ProfileDto**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
No authorization required
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | Profile soft-deleted | - |
|
|
121
|
+
|**401** | Unauthorized | - |
|
|
122
|
+
|**404** | Not found | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
72
126
|
# **profilesControllerGetProfile**
|
|
73
127
|
> ProfileDto profilesControllerGetProfile()
|
|
74
128
|
|
|
@@ -185,11 +239,13 @@ const apiInstance = new ProfilesApi(configuration);
|
|
|
185
239
|
let page: number; //1-based page number. (optional) (default to 1)
|
|
186
240
|
let limit: number; //Page size. (optional) (default to 10)
|
|
187
241
|
let tags: Array<string>; //Filter profiles by tags (any match). Pass multiple times or comma-separated. (optional) (default to undefined)
|
|
242
|
+
let includeDeleted: boolean; //Include soft-deleted profiles in the results. Defaults to false. (optional) (default to false)
|
|
188
243
|
|
|
189
244
|
const { status, data } = await apiInstance.profilesControllerListProfiles(
|
|
190
245
|
page,
|
|
191
246
|
limit,
|
|
192
|
-
tags
|
|
247
|
+
tags,
|
|
248
|
+
includeDeleted
|
|
193
249
|
);
|
|
194
250
|
```
|
|
195
251
|
|
|
@@ -200,6 +256,7 @@ const { status, data } = await apiInstance.profilesControllerListProfiles(
|
|
|
200
256
|
| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
|
|
201
257
|
| **limit** | [**number**] | Page size. | (optional) defaults to 10|
|
|
202
258
|
| **tags** | **Array<string>** | Filter profiles by tags (any match). Pass multiple times or comma-separated. | (optional) defaults to undefined|
|
|
259
|
+
| **includeDeleted** | [**boolean**] | Include soft-deleted profiles in the results. Defaults to false. | (optional) defaults to false|
|
|
203
260
|
|
|
204
261
|
|
|
205
262
|
### Return type
|