@agravity/private 9.0.3 → 9.1.0

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.
@@ -7,6 +7,8 @@ api/assetIconRuleManagement.agravity.ts
7
7
  api/assetManagement.agravity.ts
8
8
  api/assetOperations.agravity.ts
9
9
  api/assetPublishing.agravity.ts
10
+ api/assetRelationManagement.agravity.ts
11
+ api/assetRelationTypeManagement.agravity.ts
10
12
  api/assetVersioning.agravity.ts
11
13
  api/authenticationManagement.agravity.ts
12
14
  api/collectionManagement.agravity.ts
@@ -52,11 +54,13 @@ model/agravityInfoResponse.agravity.ts
52
54
  model/agravityPortalUser.agravity.ts
53
55
  model/agravityUser.agravity.ts
54
56
  model/agravityUserDto.agravity.ts
57
+ model/agravityUserOnlineStatus.agravity.ts
55
58
  model/agravityVersion.agravity.ts
59
+ model/aiGroup.agravity.ts
60
+ model/aiGroupEntity.agravity.ts
56
61
  model/allWebAppData.agravity.ts
57
62
  model/apiKeyResponse.agravity.ts
58
63
  model/appConfigTableEntity.agravity.ts
59
- model/artificialIntelligenceGroup.agravity.ts
60
64
  model/asset.agravity.ts
61
65
  model/assetAvailability.agravity.ts
62
66
  model/assetBlob.agravity.ts
@@ -65,6 +69,8 @@ model/assetCollectionLink.agravity.ts
65
69
  model/assetIconRule.agravity.ts
66
70
  model/assetIdFormat.agravity.ts
67
71
  model/assetPageResult.agravity.ts
72
+ model/assetRelation.agravity.ts
73
+ model/assetRelationType.agravity.ts
68
74
  model/assetTextContent.agravity.ts
69
75
  model/assetsOperationBody.agravity.ts
70
76
  model/azSearchOptions.agravity.ts
@@ -113,6 +119,7 @@ model/publishEntity.agravity.ts
113
119
  model/publishedAsset.agravity.ts
114
120
  model/quickShare.agravity.ts
115
121
  model/quickShareFull.agravity.ts
122
+ model/relatedAsset.agravity.ts
116
123
  model/sasToken.agravity.ts
117
124
  model/savedSearch.agravity.ts
118
125
  model/searchAdminDataSourceStatus.agravity.ts
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- ## @agravity/private@9.0.3
1
+ ## @agravity/private@9.1.0
2
2
 
3
3
  <h1>Agravity API Reference</h1>This is the full API description of Agravity GmbH.<br/><h2>Resources</h2><ul> <li>Collection type management</li> <li>Collections management</li> <li>Assets management</li> <li>Assets operations</li> <li>Assets publishing</li> <li>Assets versioning</li> <li>Sharing collection</li> <li>Secure upload to collection</li> <li>Download ZIP</li> <li>Search</li> <li>General management</li> <li>Authentication management</li> <li>Blob management</li> <li>Queue management</li> <li>Structure management</li> <li>Bulk get all data from collection / collection type</li></ul><h2> Operations</h2>Agravity API performs the following operations:<ul> <li>Create / update / list / delete collection types</li> <li>Create / update / list / delete collections</li> <li>Create / update / list / delete assets</li> <li>Operations on assets like: move to collection, renew asset(through queue pipe), rotate, resize, etc.</li> <li>Publish / de-publish an asset or specific variants of an asset</li> <li>Create / delete version of asset</li> <li>Bulk download of Assets</li> <li>Search for assets or collections</li> <li>Authenticated access like e.g. getting access to blobs directly (for upload on folder or generate SAS token)</li> <li>List / delete blobs</li> <li>Create structures based on blob storage input</li></ul><br/>Copyright © Agravity GmbH 2025. All Rights Reserved
4
4
 
5
- The version of the OpenAPI document: 9.0.3
5
+ The version of the OpenAPI document: 9.1.0
6
6
 
7
7
  ### Building
8
8
 
@@ -23,7 +23,7 @@ Navigate to the folder of your consuming project and run one of next commands.
23
23
  _published:_
24
24
 
25
25
  ```
26
- npm install @agravity/private@9.0.3 --save
26
+ npm install @agravity/private@9.1.0 --save
27
27
  ```
28
28
 
29
29
  _without publishing (not recommended):_
package/api/api.ts CHANGED
@@ -6,6 +6,10 @@ export * from './assetOperations.agravity';
6
6
  import { AssetOperationsService } from './assetOperations.agravity';
7
7
  export * from './assetPublishing.agravity';
8
8
  import { AssetPublishingService } from './assetPublishing.agravity';
9
+ export * from './assetRelationManagement.agravity';
10
+ import { AssetRelationManagementService } from './assetRelationManagement.agravity';
11
+ export * from './assetRelationTypeManagement.agravity';
12
+ import { AssetRelationTypeManagementService } from './assetRelationTypeManagement.agravity';
9
13
  export * from './assetVersioning.agravity';
10
14
  import { AssetVersioningService } from './assetVersioning.agravity';
11
15
  export * from './authenticationManagement.agravity';
@@ -83,6 +87,8 @@ export const APIS = [
83
87
  AssetManagementService,
84
88
  AssetOperationsService,
85
89
  AssetPublishingService,
90
+ AssetRelationManagementService,
91
+ AssetRelationTypeManagementService,
86
92
  AssetVersioningService,
87
93
  AuthenticationManagementService,
88
94
  CollectionManagementService,
@@ -19,12 +19,16 @@ import { AgravityErrorResponse } from '../model/agravityErrorResponse.agravity';
19
19
  // @ts-ignore
20
20
  import { AgravityInfoResponse } from '../model/agravityInfoResponse.agravity';
21
21
  // @ts-ignore
22
+ import { AiGroupEntity } from '../model/aiGroupEntity.agravity';
23
+ // @ts-ignore
22
24
  import { Asset } from '../model/asset.agravity';
23
25
  // @ts-ignore
24
26
  import { AssetAvailability } from '../model/assetAvailability.agravity';
25
27
  // @ts-ignore
26
28
  import { AssetBlob } from '../model/assetBlob.agravity';
27
29
  // @ts-ignore
30
+ import { AssetRelation } from '../model/assetRelation.agravity';
31
+ // @ts-ignore
28
32
  import { AssetTextContent } from '../model/assetTextContent.agravity';
29
33
  // @ts-ignore
30
34
  import { AssetsOperationBody } from '../model/assetsOperationBody.agravity';
@@ -116,6 +120,11 @@ export interface HttpDeleteSpecificBlobRequestParams {
116
120
  name: string;
117
121
  }
118
122
 
123
+ export interface HttpGetAiGroupEntityByIdRequestParams {
124
+ /** The ID of the asset. */
125
+ id: string;
126
+ }
127
+
119
128
  export interface HttpGetAllAssetsCheckOnCriteriaRequestParams {
120
129
  /** Give the plain md5 string as parameter to be checked on all assets. */
121
130
  md5: string;
@@ -128,6 +137,11 @@ export interface HttpGetAssetBlobRequestParams {
128
137
  c?: string;
129
138
  }
130
139
 
140
+ export interface HttpGetAssetCaptionByIdRequestParams {
141
+ /** The ID of the asset. */
142
+ id: string;
143
+ }
144
+
131
145
  export interface HttpGetAssetCollectionsByIdRequestParams {
132
146
  /** The ID of the asset. */
133
147
  id: string;
@@ -150,6 +164,11 @@ export interface HttpGetAssetDownloadRequestParams {
150
164
  portalId?: string;
151
165
  }
152
166
 
167
+ export interface HttpGetAssetRelationsByIdRequestParams {
168
+ /** The ID of the asset. */
169
+ id: string;
170
+ }
171
+
153
172
  export interface HttpGetAssetTechDataByIdRequestParams {
154
173
  /** The ID of the asset. */
155
174
  id: string;
@@ -284,7 +303,7 @@ export class AssetOperationsService {
284
303
  }
285
304
 
286
305
  /**
287
- * This endpoint lets you resize/modify the image asset according to the given parameter(s).
306
+ * This endpoint lets you resize/modify the image asset according to the given GET parameter(s) - Only exception is for target: If this is a download format no other parameter is used.
288
307
  * @param requestParameters
289
308
  * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
290
309
  * @param reportProgress flag to report request and response progress.
@@ -972,6 +991,93 @@ export class AssetOperationsService {
972
991
  });
973
992
  }
974
993
 
994
+ /**
995
+ * This endpoint returns the asset ai group entity
996
+ * @param requestParameters
997
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
998
+ * @param reportProgress flag to report request and response progress.
999
+ */
1000
+ public httpGetAiGroupEntityById(
1001
+ requestParameters?: HttpGetAiGroupEntityByIdRequestParams,
1002
+ observe?: 'body',
1003
+ reportProgress?: boolean,
1004
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1005
+ ): Observable<AiGroupEntity>;
1006
+ public httpGetAiGroupEntityById(
1007
+ requestParameters?: HttpGetAiGroupEntityByIdRequestParams,
1008
+ observe?: 'response',
1009
+ reportProgress?: boolean,
1010
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1011
+ ): Observable<HttpResponse<AiGroupEntity>>;
1012
+ public httpGetAiGroupEntityById(
1013
+ requestParameters?: HttpGetAiGroupEntityByIdRequestParams,
1014
+ observe?: 'events',
1015
+ reportProgress?: boolean,
1016
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1017
+ ): Observable<HttpEvent<AiGroupEntity>>;
1018
+ public httpGetAiGroupEntityById(
1019
+ requestParameters?: HttpGetAiGroupEntityByIdRequestParams,
1020
+ observe: any = 'body',
1021
+ reportProgress: boolean = false,
1022
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1023
+ ): Observable<any> {
1024
+ const id = requestParameters?.id;
1025
+ if (id === null || id === undefined) {
1026
+ throw new Error('Required parameter id was null or undefined when calling httpGetAiGroupEntityById.');
1027
+ }
1028
+
1029
+ let localVarHeaders = this.defaultHeaders;
1030
+
1031
+ let localVarCredential: string | undefined;
1032
+ // authentication (msal_auth) required
1033
+ localVarCredential = this.configuration.lookupCredential('msal_auth');
1034
+ if (localVarCredential) {
1035
+ localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
1036
+ }
1037
+
1038
+ let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
1039
+ if (localVarHttpHeaderAcceptSelected === undefined) {
1040
+ // to determine the Accept header
1041
+ const httpHeaderAccepts: string[] = ['application/json'];
1042
+ localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
1043
+ }
1044
+ if (localVarHttpHeaderAcceptSelected !== undefined) {
1045
+ localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
1046
+ }
1047
+
1048
+ let localVarHttpContext: HttpContext | undefined = options && options.context;
1049
+ if (localVarHttpContext === undefined) {
1050
+ localVarHttpContext = new HttpContext();
1051
+ }
1052
+
1053
+ let localVarTransferCache: boolean | undefined = options && options.transferCache;
1054
+ if (localVarTransferCache === undefined) {
1055
+ localVarTransferCache = true;
1056
+ }
1057
+
1058
+ let responseType_: 'text' | 'json' | 'blob' = 'json';
1059
+ if (localVarHttpHeaderAcceptSelected) {
1060
+ if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
1061
+ responseType_ = 'text';
1062
+ } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
1063
+ responseType_ = 'json';
1064
+ } else {
1065
+ responseType_ = 'blob';
1066
+ }
1067
+ }
1068
+
1069
+ let localVarPath = `/assets/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/aigroup`;
1070
+ return this.httpClient.request<AiGroupEntity>('get', `${this.configuration.basePath}${localVarPath}`, {
1071
+ context: localVarHttpContext,
1072
+ responseType: <any>responseType_,
1073
+ withCredentials: this.configuration.withCredentials,
1074
+ headers: localVarHeaders,
1075
+ observe: observe,
1076
+ transferCache: localVarTransferCache,
1077
+ reportProgress: reportProgress
1078
+ });
1079
+ }
1080
+
975
1081
  /**
976
1082
  * This endpoint allows to check all assets in system elements with the given criteria are already in the system. Currently supported field: md5
977
1083
  * @param requestParameters
@@ -1159,6 +1265,93 @@ export class AssetOperationsService {
1159
1265
  });
1160
1266
  }
1161
1267
 
1268
+ /**
1269
+ * This endpoint returns the asset caption
1270
+ * @param requestParameters
1271
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
1272
+ * @param reportProgress flag to report request and response progress.
1273
+ */
1274
+ public httpGetAssetCaptionById(
1275
+ requestParameters?: HttpGetAssetCaptionByIdRequestParams,
1276
+ observe?: 'body',
1277
+ reportProgress?: boolean,
1278
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1279
+ ): Observable<string>;
1280
+ public httpGetAssetCaptionById(
1281
+ requestParameters?: HttpGetAssetCaptionByIdRequestParams,
1282
+ observe?: 'response',
1283
+ reportProgress?: boolean,
1284
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1285
+ ): Observable<HttpResponse<string>>;
1286
+ public httpGetAssetCaptionById(
1287
+ requestParameters?: HttpGetAssetCaptionByIdRequestParams,
1288
+ observe?: 'events',
1289
+ reportProgress?: boolean,
1290
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1291
+ ): Observable<HttpEvent<string>>;
1292
+ public httpGetAssetCaptionById(
1293
+ requestParameters?: HttpGetAssetCaptionByIdRequestParams,
1294
+ observe: any = 'body',
1295
+ reportProgress: boolean = false,
1296
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1297
+ ): Observable<any> {
1298
+ const id = requestParameters?.id;
1299
+ if (id === null || id === undefined) {
1300
+ throw new Error('Required parameter id was null or undefined when calling httpGetAssetCaptionById.');
1301
+ }
1302
+
1303
+ let localVarHeaders = this.defaultHeaders;
1304
+
1305
+ let localVarCredential: string | undefined;
1306
+ // authentication (msal_auth) required
1307
+ localVarCredential = this.configuration.lookupCredential('msal_auth');
1308
+ if (localVarCredential) {
1309
+ localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
1310
+ }
1311
+
1312
+ let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
1313
+ if (localVarHttpHeaderAcceptSelected === undefined) {
1314
+ // to determine the Accept header
1315
+ const httpHeaderAccepts: string[] = ['application/json'];
1316
+ localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
1317
+ }
1318
+ if (localVarHttpHeaderAcceptSelected !== undefined) {
1319
+ localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
1320
+ }
1321
+
1322
+ let localVarHttpContext: HttpContext | undefined = options && options.context;
1323
+ if (localVarHttpContext === undefined) {
1324
+ localVarHttpContext = new HttpContext();
1325
+ }
1326
+
1327
+ let localVarTransferCache: boolean | undefined = options && options.transferCache;
1328
+ if (localVarTransferCache === undefined) {
1329
+ localVarTransferCache = true;
1330
+ }
1331
+
1332
+ let responseType_: 'text' | 'json' | 'blob' = 'json';
1333
+ if (localVarHttpHeaderAcceptSelected) {
1334
+ if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
1335
+ responseType_ = 'text';
1336
+ } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
1337
+ responseType_ = 'json';
1338
+ } else {
1339
+ responseType_ = 'blob';
1340
+ }
1341
+ }
1342
+
1343
+ let localVarPath = `/assets/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/caption`;
1344
+ return this.httpClient.request<string>('get', `${this.configuration.basePath}${localVarPath}`, {
1345
+ context: localVarHttpContext,
1346
+ responseType: <any>responseType_,
1347
+ withCredentials: this.configuration.withCredentials,
1348
+ headers: localVarHeaders,
1349
+ observe: observe,
1350
+ transferCache: localVarTransferCache,
1351
+ reportProgress: reportProgress
1352
+ });
1353
+ }
1354
+
1162
1355
  /**
1163
1356
  * This endpoint returns all collections of a specific asset.
1164
1357
  * @param requestParameters
@@ -1363,6 +1556,93 @@ export class AssetOperationsService {
1363
1556
  });
1364
1557
  }
1365
1558
 
1559
+ /**
1560
+ * This endpoint returns the asset relations
1561
+ * @param requestParameters
1562
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
1563
+ * @param reportProgress flag to report request and response progress.
1564
+ */
1565
+ public httpGetAssetRelationsById(
1566
+ requestParameters?: HttpGetAssetRelationsByIdRequestParams,
1567
+ observe?: 'body',
1568
+ reportProgress?: boolean,
1569
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1570
+ ): Observable<Array<AssetRelation>>;
1571
+ public httpGetAssetRelationsById(
1572
+ requestParameters?: HttpGetAssetRelationsByIdRequestParams,
1573
+ observe?: 'response',
1574
+ reportProgress?: boolean,
1575
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1576
+ ): Observable<HttpResponse<Array<AssetRelation>>>;
1577
+ public httpGetAssetRelationsById(
1578
+ requestParameters?: HttpGetAssetRelationsByIdRequestParams,
1579
+ observe?: 'events',
1580
+ reportProgress?: boolean,
1581
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1582
+ ): Observable<HttpEvent<Array<AssetRelation>>>;
1583
+ public httpGetAssetRelationsById(
1584
+ requestParameters?: HttpGetAssetRelationsByIdRequestParams,
1585
+ observe: any = 'body',
1586
+ reportProgress: boolean = false,
1587
+ options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
1588
+ ): Observable<any> {
1589
+ const id = requestParameters?.id;
1590
+ if (id === null || id === undefined) {
1591
+ throw new Error('Required parameter id was null or undefined when calling httpGetAssetRelationsById.');
1592
+ }
1593
+
1594
+ let localVarHeaders = this.defaultHeaders;
1595
+
1596
+ let localVarCredential: string | undefined;
1597
+ // authentication (msal_auth) required
1598
+ localVarCredential = this.configuration.lookupCredential('msal_auth');
1599
+ if (localVarCredential) {
1600
+ localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
1601
+ }
1602
+
1603
+ let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
1604
+ if (localVarHttpHeaderAcceptSelected === undefined) {
1605
+ // to determine the Accept header
1606
+ const httpHeaderAccepts: string[] = ['application/json'];
1607
+ localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
1608
+ }
1609
+ if (localVarHttpHeaderAcceptSelected !== undefined) {
1610
+ localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
1611
+ }
1612
+
1613
+ let localVarHttpContext: HttpContext | undefined = options && options.context;
1614
+ if (localVarHttpContext === undefined) {
1615
+ localVarHttpContext = new HttpContext();
1616
+ }
1617
+
1618
+ let localVarTransferCache: boolean | undefined = options && options.transferCache;
1619
+ if (localVarTransferCache === undefined) {
1620
+ localVarTransferCache = true;
1621
+ }
1622
+
1623
+ let responseType_: 'text' | 'json' | 'blob' = 'json';
1624
+ if (localVarHttpHeaderAcceptSelected) {
1625
+ if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
1626
+ responseType_ = 'text';
1627
+ } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
1628
+ responseType_ = 'json';
1629
+ } else {
1630
+ responseType_ = 'blob';
1631
+ }
1632
+ }
1633
+
1634
+ let localVarPath = `/assets/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/relations`;
1635
+ return this.httpClient.request<Array<AssetRelation>>('get', `${this.configuration.basePath}${localVarPath}`, {
1636
+ context: localVarHttpContext,
1637
+ responseType: <any>responseType_,
1638
+ withCredentials: this.configuration.withCredentials,
1639
+ headers: localVarHeaders,
1640
+ observe: observe,
1641
+ transferCache: localVarTransferCache,
1642
+ reportProgress: reportProgress
1643
+ });
1644
+ }
1645
+
1366
1646
  /**
1367
1647
  * This endpoint returns all technical metadata of an asset.
1368
1648
  * @param requestParameters