@agravity/private 5.2.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.
Files changed (119) hide show
  1. package/.openapi-generator/FILES +117 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +203 -0
  5. package/api/api.ts +67 -0
  6. package/api/assetIconRuleManagement.agravity.ts +400 -0
  7. package/api/assetManagement.agravity.ts +737 -0
  8. package/api/assetOperations.agravity.ts +1309 -0
  9. package/api/assetPublishing.agravity.ts +511 -0
  10. package/api/assetVersioning.agravity.ts +657 -0
  11. package/api/authenticationManagement.agravity.ts +502 -0
  12. package/api/collectionManagement.agravity.ts +618 -0
  13. package/api/collectionSharing.agravity.ts +329 -0
  14. package/api/collectionTypeItemBlueprintManagement.agravity.ts +340 -0
  15. package/api/collectionTypeManagement.agravity.ts +533 -0
  16. package/api/configurationManagement.agravity.ts +311 -0
  17. package/api/downloadFormatManagement.agravity.ts +400 -0
  18. package/api/downloadZip.agravity.ts +151 -0
  19. package/api/generalManagement.agravity.ts +348 -0
  20. package/api/helperTools.agravity.ts +640 -0
  21. package/api/iccProfileManagement.agravity.ts +134 -0
  22. package/api/listBlobs.agravity.ts +185 -0
  23. package/api/listQueues.agravity.ts +134 -0
  24. package/api/permissionsManagement.agravity.ts +262 -0
  25. package/api/publishing.agravity.ts +148 -0
  26. package/api/quickshareManagement.agravity.ts +385 -0
  27. package/api/savedSearchManagement.agravity.ts +271 -0
  28. package/api/searchManagement.agravity.ts +345 -0
  29. package/api/secureUpload.agravity.ts +371 -0
  30. package/api/signalRConnectionManagement.agravity.ts +218 -0
  31. package/api/staticDefinedListManagement.agravity.ts +408 -0
  32. package/api/stockImport.agravity.ts +221 -0
  33. package/api/structureImport.agravity.ts +137 -0
  34. package/api/translationManagement.agravity.ts +404 -0
  35. package/api/upgradeManagement.agravity.ts +333 -0
  36. package/api/webAppData.agravity.ts +300 -0
  37. package/api/wordpressManagement.agravity.ts +282 -0
  38. package/api/workspaceManagement.agravity.ts +513 -0
  39. package/api.module.ts +63 -0
  40. package/configuration.ts +130 -0
  41. package/encoder.ts +20 -0
  42. package/git_push.sh +58 -0
  43. package/index.ts +5 -0
  44. package/model/agravityErrorResponse.agravity.ts +19 -0
  45. package/model/agravityInfoResponse.agravity.ts +19 -0
  46. package/model/agravityUser.agravity.ts +37 -0
  47. package/model/agravityVersion.agravity.ts +24 -0
  48. package/model/allWebAppData.agravity.ts +24 -0
  49. package/model/apiKeyResponse.agravity.ts +18 -0
  50. package/model/appConfigTableEntity.agravity.ts +25 -0
  51. package/model/artificialIntelligenceGroup.agravity.ts +20 -0
  52. package/model/asset.agravity.ts +47 -0
  53. package/model/assetAvailability.agravity.ts +19 -0
  54. package/model/assetBlob.agravity.ts +82 -0
  55. package/model/assetBulkUpdate.agravity.ts +20 -0
  56. package/model/assetCollectionLink.agravity.ts +18 -0
  57. package/model/assetIconRule.agravity.ts +35 -0
  58. package/model/assetIdContainer.agravity.ts +18 -0
  59. package/model/assetPageResult.agravity.ts +23 -0
  60. package/model/assetsOperationBody.agravity.ts +20 -0
  61. package/model/azSearchOptions.agravity.ts +25 -0
  62. package/model/azureIdentity.agravity.ts +30 -0
  63. package/model/blobInfoObj.agravity.ts +23 -0
  64. package/model/collTypeItem.agravity.ts +38 -0
  65. package/model/collTypeItemBlueprint.agravity.ts +31 -0
  66. package/model/collection.agravity.ts +35 -0
  67. package/model/collectionType.agravity.ts +35 -0
  68. package/model/collectionUDL.agravity.ts +21 -0
  69. package/model/createSftpUserResult.agravity.ts +18 -0
  70. package/model/dataResult.agravity.ts +22 -0
  71. package/model/distZipResponse.agravity.ts +19 -0
  72. package/model/downloadFormat.agravity.ts +34 -0
  73. package/model/downloadObject.agravity.ts +32 -0
  74. package/model/downloadZipRequest.agravity.ts +25 -0
  75. package/model/dynamicImageOperation.agravity.ts +18 -0
  76. package/model/emailAddress.agravity.ts +18 -0
  77. package/model/entityId.agravity.ts +17 -0
  78. package/model/entityIdName.agravity.ts +19 -0
  79. package/model/entityTranslations.agravity.ts +18 -0
  80. package/model/frontendAppConfig.agravity.ts +21 -0
  81. package/model/groupAllAppData.agravity.ts +26 -0
  82. package/model/infoEntitySkillEnhanced.agravity.ts +25 -0
  83. package/model/metadata.agravity.ts +19 -0
  84. package/model/models.ts +73 -0
  85. package/model/moveCollectionBody.agravity.ts +19 -0
  86. package/model/permissionChange.agravity.ts +29 -0
  87. package/model/permissionSetting.agravity.ts +27 -0
  88. package/model/publishEntity.agravity.ts +28 -0
  89. package/model/publishedAsset.agravity.ts +25 -0
  90. package/model/quickShare.agravity.ts +31 -0
  91. package/model/quickShareFull.agravity.ts +36 -0
  92. package/model/sasToken.agravity.ts +22 -0
  93. package/model/savedSearch.agravity.ts +31 -0
  94. package/model/searchAdminDataSourceStatus.agravity.ts +18 -0
  95. package/model/searchAdminIndexStatus.agravity.ts +20 -0
  96. package/model/searchAdminIndexerLastRun.agravity.ts +21 -0
  97. package/model/searchAdminIndexerStatus.agravity.ts +20 -0
  98. package/model/searchAdminSkillStatus.agravity.ts +18 -0
  99. package/model/searchAdminStatistics.agravity.ts +18 -0
  100. package/model/searchAdminStatus.agravity.ts +24 -0
  101. package/model/searchFacet.agravity.ts +19 -0
  102. package/model/searchFacetEntity.agravity.ts +19 -0
  103. package/model/searchResult.agravity.ts +23 -0
  104. package/model/searchableItem.agravity.ts +26 -0
  105. package/model/secureUploadEntity.agravity.ts +27 -0
  106. package/model/sharedAsset.agravity.ts +25 -0
  107. package/model/sharedCollection.agravity.ts +24 -0
  108. package/model/sharedCollectionFull.agravity.ts +29 -0
  109. package/model/signalRConnectionInfo.agravity.ts +18 -0
  110. package/model/simpleAsset.agravity.ts +26 -0
  111. package/model/staticDefinedList.agravity.ts +30 -0
  112. package/model/uiTutorials.agravity.ts +26 -0
  113. package/model/upgradeV2V3CollectionCustomItemTableEntity.agravity.ts +21 -0
  114. package/model/versionEntity.agravity.ts +28 -0
  115. package/model/versionedAsset.agravity.ts +20 -0
  116. package/model/whereParam.agravity.ts +43 -0
  117. package/model/workspace.agravity.ts +34 -0
  118. package/package.json +28 -0
  119. package/variables.ts +9 -0
@@ -0,0 +1,618 @@
1
+ /**
2
+ * Agravity OpenAPI Documentation - Private Functions
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 2023. All Rights Reserved
4
+ *
5
+ * The version of the OpenAPI document: 5.2.0
6
+ * Contact: office@agravity.io
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /* tslint:disable:no-unused-variable member-ordering */
13
+
14
+ import { Inject, Injectable, Optional } from '@angular/core';
15
+ import { HttpClient, HttpHeaders, HttpParams,
16
+ HttpResponse, HttpEvent, HttpParameterCodec } from '@angular/common/http';
17
+ import { CustomHttpParameterCodec } from '../encoder';
18
+ import { Observable } from 'rxjs';
19
+
20
+ import { AgravityErrorResponse } from '../model/models';
21
+ import { Collection } from '../model/models';
22
+
23
+ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
24
+ import { AgravityConfiguration } from '../configuration';
25
+
26
+
27
+
28
+ @Injectable({
29
+ providedIn: 'root'
30
+ })
31
+ export class CollectionManagementService {
32
+
33
+ protected basePath = 'http://localhost:7071/api';
34
+ public defaultHeaders = new HttpHeaders();
35
+ public configuration = new AgravityConfiguration();
36
+ public encoder: HttpParameterCodec;
37
+
38
+ constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: AgravityConfiguration) {
39
+ if (configuration) {
40
+ this.configuration = configuration;
41
+ }
42
+ if (typeof this.configuration.basePath !== 'string') {
43
+ if (typeof basePath !== 'string') {
44
+ basePath = this.basePath;
45
+ }
46
+ this.configuration.basePath = basePath;
47
+ }
48
+ this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
49
+ }
50
+
51
+
52
+ private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
53
+ if (typeof value === "object" && value instanceof Date === false) {
54
+ httpParams = this.addToHttpParamsRecursive(httpParams, value);
55
+ } else {
56
+ httpParams = this.addToHttpParamsRecursive(httpParams, value, key);
57
+ }
58
+ return httpParams;
59
+ }
60
+
61
+ private addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
62
+ if (value == null) {
63
+ return httpParams;
64
+ }
65
+
66
+ if (typeof value === "object") {
67
+ if (Array.isArray(value)) {
68
+ (value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
69
+ } else if (value instanceof Date) {
70
+ if (key != null) {
71
+ httpParams = httpParams.append(key,
72
+ (value as Date).toISOString().substr(0, 10));
73
+ } else {
74
+ throw Error("key may not be null if value is Date");
75
+ }
76
+ } else {
77
+ Object.keys(value).forEach( k => httpParams = this.addToHttpParamsRecursive(
78
+ httpParams, value[k], key != null ? `${key}.${k}` : k));
79
+ }
80
+ } else if (key != null) {
81
+ httpParams = httpParams.append(key, value);
82
+ } else {
83
+ throw Error("key may not be null if value is not object or array");
84
+ }
85
+ return httpParams;
86
+ }
87
+
88
+ /**
89
+ * This endpoint creates a unique collection ID and adds the information to the database.
90
+ * @param collectiontypeid The ID of the collection type where this collections should be assigned.
91
+ * @param collection This endpoint creates a unique collection ID and adds the information to the database.
92
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
93
+ * @param reportProgress flag to report request and response progress.
94
+ */
95
+ public httpCollectionsCreate(collectiontypeid: string, collection: Collection, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Collection>;
96
+ public httpCollectionsCreate(collectiontypeid: string, collection: Collection, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Collection>>;
97
+ public httpCollectionsCreate(collectiontypeid: string, collection: Collection, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Collection>>;
98
+ public httpCollectionsCreate(collectiontypeid: string, collection: Collection, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
99
+ if (collectiontypeid === null || collectiontypeid === undefined) {
100
+ throw new Error('Required parameter collectiontypeid was null or undefined when calling httpCollectionsCreate.');
101
+ }
102
+ if (collection === null || collection === undefined) {
103
+ throw new Error('Required parameter collection was null or undefined when calling httpCollectionsCreate.');
104
+ }
105
+
106
+ let queryParameters = new HttpParams({encoder: this.encoder});
107
+ if (collectiontypeid !== undefined && collectiontypeid !== null) {
108
+ queryParameters = this.addToHttpParams(queryParameters,
109
+ <any>collectiontypeid, 'collectiontypeid');
110
+ }
111
+
112
+ let headers = this.defaultHeaders;
113
+
114
+ let credential: string | undefined;
115
+ // authentication (msal_auth) required
116
+ credential = this.configuration.lookupCredential('msal_auth');
117
+ if (credential) {
118
+ headers = headers.set('Authorization', 'Bearer ' + credential);
119
+ }
120
+
121
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
122
+ if (httpHeaderAcceptSelected === undefined) {
123
+ // to determine the Accept header
124
+ const httpHeaderAccepts: string[] = [
125
+ 'application/json'
126
+ ];
127
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
128
+ }
129
+ if (httpHeaderAcceptSelected !== undefined) {
130
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
131
+ }
132
+
133
+
134
+ // to determine the Content-Type header
135
+ const consumes: string[] = [
136
+ 'application/json'
137
+ ];
138
+ const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes);
139
+ if (httpContentTypeSelected !== undefined) {
140
+ headers = headers.set('Content-Type', httpContentTypeSelected);
141
+ }
142
+
143
+ let responseType_: 'text' | 'json' = 'json';
144
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
145
+ responseType_ = 'text';
146
+ }
147
+
148
+ return this.httpClient.post<Collection>(`${this.configuration.basePath}/collections`,
149
+ collection,
150
+ {
151
+ params: queryParameters,
152
+ responseType: <any>responseType_,
153
+ withCredentials: this.configuration.withCredentials,
154
+ headers: headers,
155
+ observe: observe,
156
+ reportProgress: reportProgress
157
+ }
158
+ );
159
+ }
160
+
161
+ /**
162
+ * This endpoint deletes the collection with the given ID (and their siblings).
163
+ * @param id The ID of the collection.
164
+ * @param deleteassets If this is true the assigned assets are set to delete as well.
165
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
166
+ * @param reportProgress flag to report request and response progress.
167
+ */
168
+ public httpCollectionsDeleteById(id: string, deleteassets?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<any>;
169
+ public httpCollectionsDeleteById(id: string, deleteassets?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<any>>;
170
+ public httpCollectionsDeleteById(id: string, deleteassets?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<any>>;
171
+ public httpCollectionsDeleteById(id: string, deleteassets?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
172
+ if (id === null || id === undefined) {
173
+ throw new Error('Required parameter id was null or undefined when calling httpCollectionsDeleteById.');
174
+ }
175
+
176
+ let queryParameters = new HttpParams({encoder: this.encoder});
177
+ if (deleteassets !== undefined && deleteassets !== null) {
178
+ queryParameters = this.addToHttpParams(queryParameters,
179
+ <any>deleteassets, 'deleteassets');
180
+ }
181
+
182
+ let headers = this.defaultHeaders;
183
+
184
+ let credential: string | undefined;
185
+ // authentication (msal_auth) required
186
+ credential = this.configuration.lookupCredential('msal_auth');
187
+ if (credential) {
188
+ headers = headers.set('Authorization', 'Bearer ' + credential);
189
+ }
190
+
191
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
192
+ if (httpHeaderAcceptSelected === undefined) {
193
+ // to determine the Accept header
194
+ const httpHeaderAccepts: string[] = [
195
+ 'application/json'
196
+ ];
197
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
198
+ }
199
+ if (httpHeaderAcceptSelected !== undefined) {
200
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
201
+ }
202
+
203
+
204
+ let responseType_: 'text' | 'json' = 'json';
205
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
206
+ responseType_ = 'text';
207
+ }
208
+
209
+ return this.httpClient.delete<any>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}`,
210
+ {
211
+ params: queryParameters,
212
+ responseType: <any>responseType_,
213
+ withCredentials: this.configuration.withCredentials,
214
+ headers: headers,
215
+ observe: observe,
216
+ reportProgress: reportProgress
217
+ }
218
+ );
219
+ }
220
+
221
+ /**
222
+ * This endpoint lists all the collections, which are stored in the database and not deleted (status \&quot;A\&quot;)
223
+ * @param collectiontypeid The ID of the collection type, where these collections should come from.
224
+ * @param level The hierarchy level of collections which should be returned.
225
+ * @param parentid The ID of the parent collection which should be queried. (No collectiontypeid is required)
226
+ * @param fields This limits the fields which are returned, separated by comma (\&#39;,\&#39;).
227
+ * @param items The items can be extended to fully filled items.
228
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
229
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
230
+ * @param reportProgress flag to report request and response progress.
231
+ */
232
+ public httpCollectionsGet(collectiontypeid?: string, level?: number, parentid?: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<Collection>>;
233
+ public httpCollectionsGet(collectiontypeid?: string, level?: number, parentid?: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<Collection>>>;
234
+ public httpCollectionsGet(collectiontypeid?: string, level?: number, parentid?: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<Collection>>>;
235
+ public httpCollectionsGet(collectiontypeid?: string, level?: number, parentid?: string, fields?: string, items?: boolean, translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
236
+
237
+ let queryParameters = new HttpParams({encoder: this.encoder});
238
+ if (collectiontypeid !== undefined && collectiontypeid !== null) {
239
+ queryParameters = this.addToHttpParams(queryParameters,
240
+ <any>collectiontypeid, 'collectiontypeid');
241
+ }
242
+ if (level !== undefined && level !== null) {
243
+ queryParameters = this.addToHttpParams(queryParameters,
244
+ <any>level, 'level');
245
+ }
246
+ if (parentid !== undefined && parentid !== null) {
247
+ queryParameters = this.addToHttpParams(queryParameters,
248
+ <any>parentid, 'parentid');
249
+ }
250
+ if (fields !== undefined && fields !== null) {
251
+ queryParameters = this.addToHttpParams(queryParameters,
252
+ <any>fields, 'fields');
253
+ }
254
+ if (items !== undefined && items !== null) {
255
+ queryParameters = this.addToHttpParams(queryParameters,
256
+ <any>items, 'items');
257
+ }
258
+ if (translations !== undefined && translations !== null) {
259
+ queryParameters = this.addToHttpParams(queryParameters,
260
+ <any>translations, 'translations');
261
+ }
262
+
263
+ let headers = this.defaultHeaders;
264
+
265
+ let credential: string | undefined;
266
+ // authentication (msal_auth) required
267
+ credential = this.configuration.lookupCredential('msal_auth');
268
+ if (credential) {
269
+ headers = headers.set('Authorization', 'Bearer ' + credential);
270
+ }
271
+
272
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
273
+ if (httpHeaderAcceptSelected === undefined) {
274
+ // to determine the Accept header
275
+ const httpHeaderAccepts: string[] = [
276
+ 'application/json'
277
+ ];
278
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
279
+ }
280
+ if (httpHeaderAcceptSelected !== undefined) {
281
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
282
+ }
283
+
284
+
285
+ let responseType_: 'text' | 'json' = 'json';
286
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
287
+ responseType_ = 'text';
288
+ }
289
+
290
+ return this.httpClient.get<Array<Collection>>(`${this.configuration.basePath}/collections`,
291
+ {
292
+ params: queryParameters,
293
+ responseType: <any>responseType_,
294
+ withCredentials: this.configuration.withCredentials,
295
+ headers: headers,
296
+ observe: observe,
297
+ reportProgress: reportProgress
298
+ }
299
+ );
300
+ }
301
+
302
+ /**
303
+ * This endpoint returns one single collection (from ID). This will include all specific properties from collection type.
304
+ * @param id The ID of the collection.
305
+ * @param fields This limits the fields which are returned, separated by comma (\&#39;,\&#39;).
306
+ * @param items The items can be extended to fully filled items.
307
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
308
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
309
+ * @param reportProgress flag to report request and response progress.
310
+ */
311
+ public httpCollectionsGetById(id: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Collection>;
312
+ public httpCollectionsGetById(id: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Collection>>;
313
+ public httpCollectionsGetById(id: string, fields?: string, items?: boolean, translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Collection>>;
314
+ public httpCollectionsGetById(id: string, fields?: string, items?: boolean, translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
315
+ if (id === null || id === undefined) {
316
+ throw new Error('Required parameter id was null or undefined when calling httpCollectionsGetById.');
317
+ }
318
+
319
+ let queryParameters = new HttpParams({encoder: this.encoder});
320
+ if (fields !== undefined && fields !== null) {
321
+ queryParameters = this.addToHttpParams(queryParameters,
322
+ <any>fields, 'fields');
323
+ }
324
+ if (items !== undefined && items !== null) {
325
+ queryParameters = this.addToHttpParams(queryParameters,
326
+ <any>items, 'items');
327
+ }
328
+ if (translations !== undefined && translations !== null) {
329
+ queryParameters = this.addToHttpParams(queryParameters,
330
+ <any>translations, 'translations');
331
+ }
332
+
333
+ let headers = this.defaultHeaders;
334
+
335
+ let credential: string | undefined;
336
+ // authentication (msal_auth) required
337
+ credential = this.configuration.lookupCredential('msal_auth');
338
+ if (credential) {
339
+ headers = headers.set('Authorization', 'Bearer ' + credential);
340
+ }
341
+
342
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
343
+ if (httpHeaderAcceptSelected === undefined) {
344
+ // to determine the Accept header
345
+ const httpHeaderAccepts: string[] = [
346
+ 'application/json'
347
+ ];
348
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
349
+ }
350
+ if (httpHeaderAcceptSelected !== undefined) {
351
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
352
+ }
353
+
354
+
355
+ let responseType_: 'text' | 'json' = 'json';
356
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
357
+ responseType_ = 'text';
358
+ }
359
+
360
+ return this.httpClient.get<Collection>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}`,
361
+ {
362
+ params: queryParameters,
363
+ responseType: <any>responseType_,
364
+ withCredentials: this.configuration.withCredentials,
365
+ headers: headers,
366
+ observe: observe,
367
+ reportProgress: reportProgress
368
+ }
369
+ );
370
+ }
371
+
372
+ /**
373
+ * This endpoint returns the complete tree of descendants from a single collection.
374
+ * @param id The ID of the collection.
375
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
376
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
377
+ * @param reportProgress flag to report request and response progress.
378
+ */
379
+ public httpCollectionsGetDescendantsTreeOfId(id: string, translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<Collection>>;
380
+ public httpCollectionsGetDescendantsTreeOfId(id: string, translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<Collection>>>;
381
+ public httpCollectionsGetDescendantsTreeOfId(id: string, translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<Collection>>>;
382
+ public httpCollectionsGetDescendantsTreeOfId(id: string, translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
383
+ if (id === null || id === undefined) {
384
+ throw new Error('Required parameter id was null or undefined when calling httpCollectionsGetDescendantsTreeOfId.');
385
+ }
386
+
387
+ let queryParameters = new HttpParams({encoder: this.encoder});
388
+ if (translations !== undefined && translations !== null) {
389
+ queryParameters = this.addToHttpParams(queryParameters,
390
+ <any>translations, 'translations');
391
+ }
392
+
393
+ let headers = this.defaultHeaders;
394
+
395
+ let credential: string | undefined;
396
+ // authentication (msal_auth) required
397
+ credential = this.configuration.lookupCredential('msal_auth');
398
+ if (credential) {
399
+ headers = headers.set('Authorization', 'Bearer ' + credential);
400
+ }
401
+
402
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
403
+ if (httpHeaderAcceptSelected === undefined) {
404
+ // to determine the Accept header
405
+ const httpHeaderAccepts: string[] = [
406
+ 'application/json'
407
+ ];
408
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
409
+ }
410
+ if (httpHeaderAcceptSelected !== undefined) {
411
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
412
+ }
413
+
414
+
415
+ let responseType_: 'text' | 'json' = 'json';
416
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
417
+ responseType_ = 'text';
418
+ }
419
+
420
+ return this.httpClient.get<Array<Collection>>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}/descendants`,
421
+ {
422
+ params: queryParameters,
423
+ responseType: <any>responseType_,
424
+ withCredentials: this.configuration.withCredentials,
425
+ headers: headers,
426
+ observe: observe,
427
+ reportProgress: reportProgress
428
+ }
429
+ );
430
+ }
431
+
432
+ /**
433
+ * This endpoint returns the complete tree of ancestors from a single collection.
434
+ * @param id The ID of the collection.
435
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
436
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
437
+ * @param reportProgress flag to report request and response progress.
438
+ */
439
+ public httpCollectionsGetTreeAncestorsOfId(id: string, translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<Collection>>;
440
+ public httpCollectionsGetTreeAncestorsOfId(id: string, translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<Collection>>>;
441
+ public httpCollectionsGetTreeAncestorsOfId(id: string, translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<Collection>>>;
442
+ public httpCollectionsGetTreeAncestorsOfId(id: string, translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
443
+ if (id === null || id === undefined) {
444
+ throw new Error('Required parameter id was null or undefined when calling httpCollectionsGetTreeAncestorsOfId.');
445
+ }
446
+
447
+ let queryParameters = new HttpParams({encoder: this.encoder});
448
+ if (translations !== undefined && translations !== null) {
449
+ queryParameters = this.addToHttpParams(queryParameters,
450
+ <any>translations, 'translations');
451
+ }
452
+
453
+ let headers = this.defaultHeaders;
454
+
455
+ let credential: string | undefined;
456
+ // authentication (msal_auth) required
457
+ credential = this.configuration.lookupCredential('msal_auth');
458
+ if (credential) {
459
+ headers = headers.set('Authorization', 'Bearer ' + credential);
460
+ }
461
+
462
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
463
+ if (httpHeaderAcceptSelected === undefined) {
464
+ // to determine the Accept header
465
+ const httpHeaderAccepts: string[] = [
466
+ 'application/json'
467
+ ];
468
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
469
+ }
470
+ if (httpHeaderAcceptSelected !== undefined) {
471
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
472
+ }
473
+
474
+
475
+ let responseType_: 'text' | 'json' = 'json';
476
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
477
+ responseType_ = 'text';
478
+ }
479
+
480
+ return this.httpClient.get<Array<Collection>>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}/ancestors`,
481
+ {
482
+ params: queryParameters,
483
+ responseType: <any>responseType_,
484
+ withCredentials: this.configuration.withCredentials,
485
+ headers: headers,
486
+ observe: observe,
487
+ reportProgress: reportProgress
488
+ }
489
+ );
490
+ }
491
+
492
+ /**
493
+ * This endpoint updates the collection. Specific properties could be updated.
494
+ * @param id The ID of the collection.
495
+ * @param collection The body has to be a valid collection json.Not fitting properties are ignored.
496
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
497
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
498
+ * @param reportProgress flag to report request and response progress.
499
+ */
500
+ public httpCollectionsUpdateById(id: string, collection: Collection, translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Collection>;
501
+ public httpCollectionsUpdateById(id: string, collection: Collection, translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Collection>>;
502
+ public httpCollectionsUpdateById(id: string, collection: Collection, translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Collection>>;
503
+ public httpCollectionsUpdateById(id: string, collection: Collection, translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
504
+ if (id === null || id === undefined) {
505
+ throw new Error('Required parameter id was null or undefined when calling httpCollectionsUpdateById.');
506
+ }
507
+ if (collection === null || collection === undefined) {
508
+ throw new Error('Required parameter collection was null or undefined when calling httpCollectionsUpdateById.');
509
+ }
510
+
511
+ let queryParameters = new HttpParams({encoder: this.encoder});
512
+ if (translations !== undefined && translations !== null) {
513
+ queryParameters = this.addToHttpParams(queryParameters,
514
+ <any>translations, 'translations');
515
+ }
516
+
517
+ let headers = this.defaultHeaders;
518
+
519
+ let credential: string | undefined;
520
+ // authentication (msal_auth) required
521
+ credential = this.configuration.lookupCredential('msal_auth');
522
+ if (credential) {
523
+ headers = headers.set('Authorization', 'Bearer ' + credential);
524
+ }
525
+
526
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
527
+ if (httpHeaderAcceptSelected === undefined) {
528
+ // to determine the Accept header
529
+ const httpHeaderAccepts: string[] = [
530
+ 'application/json'
531
+ ];
532
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
533
+ }
534
+ if (httpHeaderAcceptSelected !== undefined) {
535
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
536
+ }
537
+
538
+
539
+ // to determine the Content-Type header
540
+ const consumes: string[] = [
541
+ 'application/json'
542
+ ];
543
+ const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes);
544
+ if (httpContentTypeSelected !== undefined) {
545
+ headers = headers.set('Content-Type', httpContentTypeSelected);
546
+ }
547
+
548
+ let responseType_: 'text' | 'json' = 'json';
549
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
550
+ responseType_ = 'text';
551
+ }
552
+
553
+ return this.httpClient.post<Collection>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}`,
554
+ collection,
555
+ {
556
+ params: queryParameters,
557
+ responseType: <any>responseType_,
558
+ withCredentials: this.configuration.withCredentials,
559
+ headers: headers,
560
+ observe: observe,
561
+ reportProgress: reportProgress
562
+ }
563
+ );
564
+ }
565
+
566
+ /**
567
+ * This endpoint returns a generated thumbnail as a preview of the containing assets.
568
+ * @param id The ID of the collection.
569
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
570
+ * @param reportProgress flag to report request and response progress.
571
+ */
572
+ public httpGetCollectionPreviewsById(id: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'image/png'}): Observable<string>;
573
+ public httpGetCollectionPreviewsById(id: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'image/png'}): Observable<HttpResponse<string>>;
574
+ public httpGetCollectionPreviewsById(id: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'image/png'}): Observable<HttpEvent<string>>;
575
+ public httpGetCollectionPreviewsById(id: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'image/png'}): Observable<any> {
576
+ if (id === null || id === undefined) {
577
+ throw new Error('Required parameter id was null or undefined when calling httpGetCollectionPreviewsById.');
578
+ }
579
+
580
+ let headers = this.defaultHeaders;
581
+
582
+ let credential: string | undefined;
583
+ // authentication (msal_auth) required
584
+ credential = this.configuration.lookupCredential('msal_auth');
585
+ if (credential) {
586
+ headers = headers.set('Authorization', 'Bearer ' + credential);
587
+ }
588
+
589
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
590
+ if (httpHeaderAcceptSelected === undefined) {
591
+ // to determine the Accept header
592
+ const httpHeaderAccepts: string[] = [
593
+ 'image/png'
594
+ ];
595
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
596
+ }
597
+ if (httpHeaderAcceptSelected !== undefined) {
598
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
599
+ }
600
+
601
+
602
+ let responseType_: 'text' | 'json' = 'json';
603
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
604
+ responseType_ = 'text';
605
+ }
606
+
607
+ return this.httpClient.get<string>(`${this.configuration.basePath}/collections/${encodeURIComponent(String(id))}/previews`,
608
+ {
609
+ responseType: <any>responseType_,
610
+ withCredentials: this.configuration.withCredentials,
611
+ headers: headers,
612
+ observe: observe,
613
+ reportProgress: reportProgress
614
+ }
615
+ );
616
+ }
617
+
618
+ }