@agravity/public 7.3.1 → 8.0.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.
- package/.openapi-generator/FILES +2 -3
- package/.openapi-generator/VERSION +1 -1
- package/README.md +29 -4
- package/api/publicAssetManagement.pub.agravity.ts +389 -265
- package/api/publicAssetOperations.pub.agravity.ts +636 -425
- package/api/publicAssetPublishing.pub.agravity.ts +195 -82
- package/api/publicAssetVersioning.pub.agravity.ts +469 -239
- package/api/publicAuthenticationManagement.pub.agravity.ts +66 -24
- package/api/publicCollectionManagement.pub.agravity.ts +525 -295
- package/api/publicCollectionSecureUpload.pub.agravity.ts +142 -69
- package/api/publicCollectionTypeManagement.pub.agravity.ts +211 -95
- package/api/publicConfigurationManagement.pub.agravity.ts +69 -26
- package/api/publicDownloadFormatManagement.pub.agravity.ts +139 -53
- package/api/publicEndpoints.pub.agravity.ts +63 -43
- package/api/publicGeneralManagement.pub.agravity.ts +253 -104
- package/api/publicHelperTools.pub.agravity.ts +270 -106
- package/api/publicPortalManagement.pub.agravity.ts +323 -124
- package/api/publicPublishing.pub.agravity.ts +69 -38
- package/api/publicSavedSearch.pub.agravity.ts +75 -38
- package/api/publicSearchManagement.pub.agravity.ts +265 -194
- package/api/publicSharingManagement.pub.agravity.ts +246 -157
- package/api/publicSignalRConnectionManagement.pub.agravity.ts +68 -24
- package/api/publicStaticDefinedListManagement.pub.agravity.ts +212 -107
- package/api/publicTranslationManagement.pub.agravity.ts +189 -115
- package/api/publicWebAppData.pub.agravity.ts +146 -47
- package/api/publicWorkspaceManagement.pub.agravity.ts +158 -57
- package/api.module.ts +0 -24
- package/configuration.ts +42 -0
- package/git_push.sh +3 -4
- package/index.ts +1 -0
- package/model/agravityErrorResponse.pub.agravity.ts +3 -4
- package/model/{badRequestResult.pub.agravity.ts → agravityInfoResponse.pub.agravity.ts} +4 -3
- package/model/agravityVersion.pub.agravity.ts +8 -9
- package/model/allWebAppData.pub.agravity.ts +4 -5
- package/model/artificialIntelligenceGroup.pub.agravity.ts +3 -4
- package/model/asset.pub.agravity.ts +22 -23
- package/model/assetAvailability.pub.agravity.ts +1 -2
- package/model/assetBlob.pub.agravity.ts +27 -28
- package/model/assetIdFormat.pub.agravity.ts +3 -4
- package/model/assetPageResult.pub.agravity.ts +4 -5
- package/model/azSearchOptions.pub.agravity.ts +8 -9
- package/model/collTypeItem.pub.agravity.ts +16 -17
- package/model/collection.pub.agravity.ts +15 -16
- package/model/collectionType.pub.agravity.ts +14 -15
- package/model/collectionUDL.pub.agravity.ts +4 -5
- package/model/createSftpUserResult.pub.agravity.ts +2 -3
- package/model/dataResult.pub.agravity.ts +4 -5
- package/model/deletedEntities.pub.agravity.ts +4 -5
- package/model/distZipResponse.pub.agravity.ts +3 -4
- package/model/downloadFormat.pub.agravity.ts +18 -16
- package/model/dynamicImageOperation.pub.agravity.ts +2 -3
- package/model/entityId.pub.agravity.ts +1 -2
- package/model/entityIdName.pub.agravity.ts +3 -4
- package/model/frontendAppConfig.pub.agravity.ts +0 -1
- package/model/groupAllAppData.pub.agravity.ts +5 -6
- package/model/models.ts +1 -3
- package/model/moveCollectionBody.pub.agravity.ts +3 -4
- package/model/permissionEntity.pub.agravity.ts +1 -2
- package/model/portal.pub.agravity.ts +18 -20
- package/model/portalConfiguration.pub.agravity.ts +23 -25
- package/model/portalLinks.pub.agravity.ts +3 -4
- package/model/portalTheme.pub.agravity.ts +6 -7
- package/model/portalZipRequest.pub.agravity.ts +14 -15
- package/model/publishEntity.pub.agravity.ts +9 -10
- package/model/publishedAsset.pub.agravity.ts +12 -13
- package/model/quickShareFull.pub.agravity.ts +15 -16
- package/model/sasToken.pub.agravity.ts +6 -7
- package/model/savedSearch.pub.agravity.ts +13 -14
- package/model/searchAdminDataSourceStatus.pub.agravity.ts +2 -3
- package/model/searchAdminIndexStatus.pub.agravity.ts +3 -4
- package/model/searchAdminIndexerLastRun.pub.agravity.ts +3 -4
- package/model/searchAdminIndexerStatus.pub.agravity.ts +4 -5
- package/model/searchAdminSkillStatus.pub.agravity.ts +2 -3
- package/model/searchAdminStatistics.pub.agravity.ts +2 -3
- package/model/searchAdminStatus.pub.agravity.ts +4 -5
- package/model/searchFacet.pub.agravity.ts +2 -3
- package/model/searchFacetEntity.pub.agravity.ts +2 -3
- package/model/searchResult.pub.agravity.ts +3 -4
- package/model/searchableItem.pub.agravity.ts +3 -4
- package/model/secureUploadEntity.pub.agravity.ts +10 -11
- package/model/sharedAllowedFormat.pub.agravity.ts +2 -3
- package/model/sharedAsset.pub.agravity.ts +5 -6
- package/model/sharedCollectionFull.pub.agravity.ts +18 -19
- package/model/sharedCollectionZipRequest.pub.agravity.ts +14 -15
- package/model/signalRConnectionInfo.pub.agravity.ts +0 -1
- package/model/staticDefinedList.pub.agravity.ts +12 -13
- package/model/versionEntity.pub.agravity.ts +9 -10
- package/model/versionedAsset.pub.agravity.ts +5 -6
- package/model/whereParam.pub.agravity.ts +0 -1
- package/model/workspace.pub.agravity.ts +14 -15
- package/package.json +16 -17
- package/param.ts +44 -0
- package/model/okResult.pub.agravity.ts +0 -15
- package/model/portalLanguages.pub.agravity.ts +0 -16
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
* Agravity OpenAPI Documentation - Public Functions
|
|
3
3
|
* <h1>Agravity API Reference</h1>This is the public 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>Collection Sharing (consume share)</li> <li>Secure Upload (validate + upload file)</li> <li>Download ZIP</li> <li>Search</li> <li>General management</li></ul><h2> Operations</h2>Agravity API performs the following operations:<ul> <li>List / get single collection types</li> <li>List / get single collections</li> <li>List / get single assets</li> <li>Operations on assets like: blobs, rotate, resize, similar, collections, customfields, download</li> <li>List / get single published asset</li> <li>Search for assets or collections</li> <li>Get version of deployment</li></ul><br/><b>API key is needed to access these endpoints.</b><br/><br/>Copyright © Agravity GmbH 2024. All Rights Reserved
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 7.3.1
|
|
6
5
|
* Contact: office@agravity.io
|
|
7
6
|
*
|
|
8
7
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,18 +11,65 @@
|
|
|
12
11
|
/* tslint:disable:no-unused-variable member-ordering */
|
|
13
12
|
|
|
14
13
|
import { Inject, Injectable, Optional } from '@angular/core';
|
|
15
|
-
import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParameterCodec } from '@angular/common/http';
|
|
14
|
+
import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
|
|
16
15
|
import { CustomHttpParameterCodec } from '../encoder';
|
|
17
16
|
import { Observable } from 'rxjs';
|
|
18
17
|
|
|
19
|
-
|
|
20
|
-
import {
|
|
21
|
-
|
|
22
|
-
import {
|
|
18
|
+
// @ts-ignore
|
|
19
|
+
import { AgravityErrorResponse } from '../model/agravityErrorResponse.pub.agravity';
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { QuickShareFull } from '../model/quickShareFull.pub.agravity';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { SharedCollectionFull } from '../model/sharedCollectionFull.pub.agravity';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import { SharedCollectionZipRequest } from '../model/sharedCollectionZipRequest.pub.agravity';
|
|
23
26
|
|
|
27
|
+
// @ts-ignore
|
|
24
28
|
import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
|
|
25
29
|
import { AgravityPublicConfiguration } from '../configuration';
|
|
26
30
|
|
|
31
|
+
export interface HttpQuickShareGetByIdRequestParams {
|
|
32
|
+
/** The ID of the quick share. */
|
|
33
|
+
id: string;
|
|
34
|
+
/** Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!) */
|
|
35
|
+
continuationToken?: string;
|
|
36
|
+
/** This number limits the page result of assets. */
|
|
37
|
+
limit?: number;
|
|
38
|
+
/** How the return assets are sorted. Default is property: created_date (newest first). */
|
|
39
|
+
orderby?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface HttpSharedCollectionsGetByIdRequestParams {
|
|
43
|
+
/** The ID of the shared collection. */
|
|
44
|
+
id: string;
|
|
45
|
+
/** If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned. */
|
|
46
|
+
ayPassword?: string;
|
|
47
|
+
/** Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!) */
|
|
48
|
+
continuationToken?: string;
|
|
49
|
+
/** This number limits the page result of assets. */
|
|
50
|
+
limit?: number;
|
|
51
|
+
/** How the return assets are sorted. Default is property: created_date (newest first). */
|
|
52
|
+
orderby?: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface HttpSharedCollectionsGetStatusZipByIdRequestParams {
|
|
56
|
+
/** The ID of the zip request collection. */
|
|
57
|
+
id: string;
|
|
58
|
+
/** The ID of the requested zip. */
|
|
59
|
+
zipId: string;
|
|
60
|
+
/** If shared collection has a password, this header is mandatory. Otherwise StatusCode 401 (Unauthorized) is returned. */
|
|
61
|
+
ayPassword?: string;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface HttpSharedCollectionsRequestZipByIdRequestParams {
|
|
65
|
+
/** The ID of the shared collection. */
|
|
66
|
+
id: string;
|
|
67
|
+
/** If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned. */
|
|
68
|
+
ayPassword?: string;
|
|
69
|
+
/** The allowed formats are the input which could be optionally added. */
|
|
70
|
+
sharedCollectionZipRequest?: SharedCollectionZipRequest;
|
|
71
|
+
}
|
|
72
|
+
|
|
27
73
|
@Injectable({
|
|
28
74
|
providedIn: 'root'
|
|
29
75
|
})
|
|
@@ -35,13 +81,18 @@ export class PublicSharingManagementService {
|
|
|
35
81
|
|
|
36
82
|
constructor(
|
|
37
83
|
protected httpClient: HttpClient,
|
|
38
|
-
@Optional() @Inject(BASE_PATH) basePath: string,
|
|
84
|
+
@Optional() @Inject(BASE_PATH) basePath: string | string[],
|
|
39
85
|
@Optional() configuration: AgravityPublicConfiguration
|
|
40
86
|
) {
|
|
41
87
|
if (configuration) {
|
|
42
88
|
this.configuration = configuration;
|
|
43
89
|
}
|
|
44
90
|
if (typeof this.configuration.basePath !== 'string') {
|
|
91
|
+
const firstBasePath = Array.isArray(basePath) ? basePath[0] : undefined;
|
|
92
|
+
if (firstBasePath != undefined) {
|
|
93
|
+
basePath = firstBasePath;
|
|
94
|
+
}
|
|
95
|
+
|
|
45
96
|
if (typeof basePath !== 'string') {
|
|
46
97
|
basePath = this.basePath;
|
|
47
98
|
}
|
|
@@ -50,6 +101,7 @@ export class PublicSharingManagementService {
|
|
|
50
101
|
this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
|
|
51
102
|
}
|
|
52
103
|
|
|
104
|
+
// @ts-ignore
|
|
53
105
|
private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
|
|
54
106
|
if (typeof value === 'object' && value instanceof Date === false) {
|
|
55
107
|
httpParams = this.addToHttpParamsRecursive(httpParams, value);
|
|
@@ -69,7 +121,7 @@ export class PublicSharingManagementService {
|
|
|
69
121
|
(value as any[]).forEach((elem) => (httpParams = this.addToHttpParamsRecursive(httpParams, elem, key)));
|
|
70
122
|
} else if (value instanceof Date) {
|
|
71
123
|
if (key != null) {
|
|
72
|
-
httpParams = httpParams.append(key, (value as Date).toISOString().
|
|
124
|
+
httpParams = httpParams.append(key, (value as Date).toISOString().substring(0, 10));
|
|
73
125
|
} else {
|
|
74
126
|
throw Error('key may not be null if value is Date');
|
|
75
127
|
}
|
|
@@ -86,338 +138,375 @@ export class PublicSharingManagementService {
|
|
|
86
138
|
|
|
87
139
|
/**
|
|
88
140
|
* Returns one single quick share (from ID)
|
|
89
|
-
* @param
|
|
90
|
-
* @param continuationToken Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!)
|
|
91
|
-
* @param limit This number limits the page result of assets.
|
|
92
|
-
* @param orderby How the return assets are sorted. Default is property: created_date (newest first).
|
|
141
|
+
* @param requestParameters
|
|
93
142
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
94
143
|
* @param reportProgress flag to report request and response progress.
|
|
95
144
|
*/
|
|
96
145
|
public httpQuickShareGetById(
|
|
97
|
-
|
|
98
|
-
continuationToken?: string,
|
|
99
|
-
limit?: number,
|
|
100
|
-
orderby?: string,
|
|
146
|
+
requestParameters?: HttpQuickShareGetByIdRequestParams,
|
|
101
147
|
observe?: 'body',
|
|
102
148
|
reportProgress?: boolean,
|
|
103
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
149
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
104
150
|
): Observable<QuickShareFull>;
|
|
105
151
|
public httpQuickShareGetById(
|
|
106
|
-
|
|
107
|
-
continuationToken?: string,
|
|
108
|
-
limit?: number,
|
|
109
|
-
orderby?: string,
|
|
152
|
+
requestParameters?: HttpQuickShareGetByIdRequestParams,
|
|
110
153
|
observe?: 'response',
|
|
111
154
|
reportProgress?: boolean,
|
|
112
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
155
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
113
156
|
): Observable<HttpResponse<QuickShareFull>>;
|
|
114
157
|
public httpQuickShareGetById(
|
|
115
|
-
|
|
116
|
-
continuationToken?: string,
|
|
117
|
-
limit?: number,
|
|
118
|
-
orderby?: string,
|
|
158
|
+
requestParameters?: HttpQuickShareGetByIdRequestParams,
|
|
119
159
|
observe?: 'events',
|
|
120
160
|
reportProgress?: boolean,
|
|
121
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
161
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
122
162
|
): Observable<HttpEvent<QuickShareFull>>;
|
|
123
163
|
public httpQuickShareGetById(
|
|
124
|
-
|
|
125
|
-
continuationToken?: string,
|
|
126
|
-
limit?: number,
|
|
127
|
-
orderby?: string,
|
|
164
|
+
requestParameters?: HttpQuickShareGetByIdRequestParams,
|
|
128
165
|
observe: any = 'body',
|
|
129
166
|
reportProgress: boolean = false,
|
|
130
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
167
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
131
168
|
): Observable<any> {
|
|
169
|
+
const id = requestParameters?.id;
|
|
132
170
|
if (id === null || id === undefined) {
|
|
133
171
|
throw new Error('Required parameter id was null or undefined when calling httpQuickShareGetById.');
|
|
134
172
|
}
|
|
173
|
+
const continuationToken = requestParameters?.continuationToken;
|
|
174
|
+
const limit = requestParameters?.limit;
|
|
175
|
+
const orderby = requestParameters?.orderby;
|
|
135
176
|
|
|
136
|
-
let
|
|
177
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
137
178
|
if (continuationToken !== undefined && continuationToken !== null) {
|
|
138
|
-
|
|
179
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>continuationToken, 'continuation_token');
|
|
139
180
|
}
|
|
140
181
|
if (limit !== undefined && limit !== null) {
|
|
141
|
-
|
|
182
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>limit, 'limit');
|
|
142
183
|
}
|
|
143
184
|
if (orderby !== undefined && orderby !== null) {
|
|
144
|
-
|
|
185
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>orderby, 'orderby');
|
|
145
186
|
}
|
|
146
187
|
|
|
147
|
-
let
|
|
188
|
+
let localVarHeaders = this.defaultHeaders;
|
|
148
189
|
|
|
149
|
-
let
|
|
150
|
-
if (
|
|
190
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
191
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
151
192
|
// to determine the Accept header
|
|
152
193
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
153
|
-
|
|
194
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
195
|
+
}
|
|
196
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
197
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
201
|
+
if (localVarHttpContext === undefined) {
|
|
202
|
+
localVarHttpContext = new HttpContext();
|
|
154
203
|
}
|
|
155
|
-
|
|
156
|
-
|
|
204
|
+
|
|
205
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
206
|
+
if (localVarTransferCache === undefined) {
|
|
207
|
+
localVarTransferCache = true;
|
|
157
208
|
}
|
|
158
209
|
|
|
159
|
-
let responseType_: 'text' | 'json' = 'json';
|
|
160
|
-
if (
|
|
161
|
-
|
|
210
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
211
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
212
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
213
|
+
responseType_ = 'text';
|
|
214
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
215
|
+
responseType_ = 'json';
|
|
216
|
+
} else {
|
|
217
|
+
responseType_ = 'blob';
|
|
218
|
+
}
|
|
162
219
|
}
|
|
163
220
|
|
|
164
|
-
|
|
165
|
-
|
|
221
|
+
let localVarPath = `/quickshares/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
222
|
+
return this.httpClient.request<QuickShareFull>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
223
|
+
context: localVarHttpContext,
|
|
224
|
+
params: localVarQueryParameters,
|
|
166
225
|
responseType: <any>responseType_,
|
|
167
226
|
withCredentials: this.configuration.withCredentials,
|
|
168
|
-
headers:
|
|
227
|
+
headers: localVarHeaders,
|
|
169
228
|
observe: observe,
|
|
229
|
+
transferCache: localVarTransferCache,
|
|
170
230
|
reportProgress: reportProgress
|
|
171
231
|
});
|
|
172
232
|
}
|
|
173
233
|
|
|
174
234
|
/**
|
|
175
235
|
* Returns one single shared collection (from ID)
|
|
176
|
-
* @param
|
|
177
|
-
* @param ayPassword If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.
|
|
178
|
-
* @param continuationToken Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!)
|
|
179
|
-
* @param limit This number limits the page result of assets.
|
|
180
|
-
* @param orderby How the return assets are sorted. Default is property: created_date (newest first).
|
|
236
|
+
* @param requestParameters
|
|
181
237
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
182
238
|
* @param reportProgress flag to report request and response progress.
|
|
183
239
|
*/
|
|
184
240
|
public httpSharedCollectionsGetById(
|
|
185
|
-
|
|
186
|
-
ayPassword?: string,
|
|
187
|
-
continuationToken?: string,
|
|
188
|
-
limit?: number,
|
|
189
|
-
orderby?: string,
|
|
241
|
+
requestParameters?: HttpSharedCollectionsGetByIdRequestParams,
|
|
190
242
|
observe?: 'body',
|
|
191
243
|
reportProgress?: boolean,
|
|
192
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
244
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
193
245
|
): Observable<SharedCollectionFull>;
|
|
194
246
|
public httpSharedCollectionsGetById(
|
|
195
|
-
|
|
196
|
-
ayPassword?: string,
|
|
197
|
-
continuationToken?: string,
|
|
198
|
-
limit?: number,
|
|
199
|
-
orderby?: string,
|
|
247
|
+
requestParameters?: HttpSharedCollectionsGetByIdRequestParams,
|
|
200
248
|
observe?: 'response',
|
|
201
249
|
reportProgress?: boolean,
|
|
202
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
250
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
203
251
|
): Observable<HttpResponse<SharedCollectionFull>>;
|
|
204
252
|
public httpSharedCollectionsGetById(
|
|
205
|
-
|
|
206
|
-
ayPassword?: string,
|
|
207
|
-
continuationToken?: string,
|
|
208
|
-
limit?: number,
|
|
209
|
-
orderby?: string,
|
|
253
|
+
requestParameters?: HttpSharedCollectionsGetByIdRequestParams,
|
|
210
254
|
observe?: 'events',
|
|
211
255
|
reportProgress?: boolean,
|
|
212
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
256
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
213
257
|
): Observable<HttpEvent<SharedCollectionFull>>;
|
|
214
258
|
public httpSharedCollectionsGetById(
|
|
215
|
-
|
|
216
|
-
ayPassword?: string,
|
|
217
|
-
continuationToken?: string,
|
|
218
|
-
limit?: number,
|
|
219
|
-
orderby?: string,
|
|
259
|
+
requestParameters?: HttpSharedCollectionsGetByIdRequestParams,
|
|
220
260
|
observe: any = 'body',
|
|
221
261
|
reportProgress: boolean = false,
|
|
222
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
262
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
223
263
|
): Observable<any> {
|
|
264
|
+
const id = requestParameters?.id;
|
|
224
265
|
if (id === null || id === undefined) {
|
|
225
266
|
throw new Error('Required parameter id was null or undefined when calling httpSharedCollectionsGetById.');
|
|
226
267
|
}
|
|
268
|
+
const ayPassword = requestParameters?.ayPassword;
|
|
269
|
+
const continuationToken = requestParameters?.continuationToken;
|
|
270
|
+
const limit = requestParameters?.limit;
|
|
271
|
+
const orderby = requestParameters?.orderby;
|
|
227
272
|
|
|
228
|
-
let
|
|
273
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
229
274
|
if (continuationToken !== undefined && continuationToken !== null) {
|
|
230
|
-
|
|
275
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>continuationToken, 'continuation_token');
|
|
231
276
|
}
|
|
232
277
|
if (limit !== undefined && limit !== null) {
|
|
233
|
-
|
|
278
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>limit, 'limit');
|
|
234
279
|
}
|
|
235
280
|
if (orderby !== undefined && orderby !== null) {
|
|
236
|
-
|
|
281
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>orderby, 'orderby');
|
|
237
282
|
}
|
|
238
283
|
|
|
239
|
-
let
|
|
284
|
+
let localVarHeaders = this.defaultHeaders;
|
|
240
285
|
if (ayPassword !== undefined && ayPassword !== null) {
|
|
241
|
-
|
|
286
|
+
localVarHeaders = localVarHeaders.set('ay-password', String(ayPassword));
|
|
242
287
|
}
|
|
243
288
|
|
|
244
|
-
let
|
|
245
|
-
if (
|
|
289
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
290
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
246
291
|
// to determine the Accept header
|
|
247
292
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
248
|
-
|
|
293
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
294
|
+
}
|
|
295
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
296
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
249
297
|
}
|
|
250
|
-
|
|
251
|
-
|
|
298
|
+
|
|
299
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
300
|
+
if (localVarHttpContext === undefined) {
|
|
301
|
+
localVarHttpContext = new HttpContext();
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
305
|
+
if (localVarTransferCache === undefined) {
|
|
306
|
+
localVarTransferCache = true;
|
|
252
307
|
}
|
|
253
308
|
|
|
254
|
-
let responseType_: 'text' | 'json' = 'json';
|
|
255
|
-
if (
|
|
256
|
-
|
|
309
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
310
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
311
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
312
|
+
responseType_ = 'text';
|
|
313
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
314
|
+
responseType_ = 'json';
|
|
315
|
+
} else {
|
|
316
|
+
responseType_ = 'blob';
|
|
317
|
+
}
|
|
257
318
|
}
|
|
258
319
|
|
|
259
|
-
|
|
260
|
-
|
|
320
|
+
let localVarPath = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
321
|
+
return this.httpClient.request<SharedCollectionFull>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
322
|
+
context: localVarHttpContext,
|
|
323
|
+
params: localVarQueryParameters,
|
|
261
324
|
responseType: <any>responseType_,
|
|
262
325
|
withCredentials: this.configuration.withCredentials,
|
|
263
|
-
headers:
|
|
326
|
+
headers: localVarHeaders,
|
|
264
327
|
observe: observe,
|
|
328
|
+
transferCache: localVarTransferCache,
|
|
265
329
|
reportProgress: reportProgress
|
|
266
330
|
});
|
|
267
331
|
}
|
|
268
332
|
|
|
269
333
|
/**
|
|
270
334
|
* This endpoint gets the progress/status of the ZIP creation of a shared collection.
|
|
271
|
-
* @param
|
|
272
|
-
* @param zipId The ID of the requested zip.
|
|
273
|
-
* @param ayPassword If shared collection has a password, this header is mandatory. Otherwise StatusCode 401 (Unauthorized) is returned.
|
|
335
|
+
* @param requestParameters
|
|
274
336
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
275
337
|
* @param reportProgress flag to report request and response progress.
|
|
276
338
|
*/
|
|
277
339
|
public httpSharedCollectionsGetStatusZipById(
|
|
278
|
-
|
|
279
|
-
zipId: string,
|
|
280
|
-
ayPassword?: string,
|
|
340
|
+
requestParameters?: HttpSharedCollectionsGetStatusZipByIdRequestParams,
|
|
281
341
|
observe?: 'body',
|
|
282
342
|
reportProgress?: boolean,
|
|
283
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
343
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
284
344
|
): Observable<SharedCollectionZipRequest>;
|
|
285
345
|
public httpSharedCollectionsGetStatusZipById(
|
|
286
|
-
|
|
287
|
-
zipId: string,
|
|
288
|
-
ayPassword?: string,
|
|
346
|
+
requestParameters?: HttpSharedCollectionsGetStatusZipByIdRequestParams,
|
|
289
347
|
observe?: 'response',
|
|
290
348
|
reportProgress?: boolean,
|
|
291
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
349
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
292
350
|
): Observable<HttpResponse<SharedCollectionZipRequest>>;
|
|
293
351
|
public httpSharedCollectionsGetStatusZipById(
|
|
294
|
-
|
|
295
|
-
zipId: string,
|
|
296
|
-
ayPassword?: string,
|
|
352
|
+
requestParameters?: HttpSharedCollectionsGetStatusZipByIdRequestParams,
|
|
297
353
|
observe?: 'events',
|
|
298
354
|
reportProgress?: boolean,
|
|
299
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
355
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
300
356
|
): Observable<HttpEvent<SharedCollectionZipRequest>>;
|
|
301
357
|
public httpSharedCollectionsGetStatusZipById(
|
|
302
|
-
|
|
303
|
-
zipId: string,
|
|
304
|
-
ayPassword?: string,
|
|
358
|
+
requestParameters?: HttpSharedCollectionsGetStatusZipByIdRequestParams,
|
|
305
359
|
observe: any = 'body',
|
|
306
360
|
reportProgress: boolean = false,
|
|
307
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
361
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
308
362
|
): Observable<any> {
|
|
363
|
+
const id = requestParameters?.id;
|
|
309
364
|
if (id === null || id === undefined) {
|
|
310
365
|
throw new Error('Required parameter id was null or undefined when calling httpSharedCollectionsGetStatusZipById.');
|
|
311
366
|
}
|
|
367
|
+
const zipId = requestParameters?.zipId;
|
|
312
368
|
if (zipId === null || zipId === undefined) {
|
|
313
369
|
throw new Error('Required parameter zipId was null or undefined when calling httpSharedCollectionsGetStatusZipById.');
|
|
314
370
|
}
|
|
371
|
+
const ayPassword = requestParameters?.ayPassword;
|
|
315
372
|
|
|
316
|
-
let
|
|
373
|
+
let localVarHeaders = this.defaultHeaders;
|
|
317
374
|
if (ayPassword !== undefined && ayPassword !== null) {
|
|
318
|
-
|
|
375
|
+
localVarHeaders = localVarHeaders.set('ay-password', String(ayPassword));
|
|
319
376
|
}
|
|
320
377
|
|
|
321
|
-
let
|
|
322
|
-
if (
|
|
378
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
379
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
323
380
|
// to determine the Accept header
|
|
324
381
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
325
|
-
|
|
382
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
326
383
|
}
|
|
327
|
-
if (
|
|
328
|
-
|
|
384
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
385
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
329
386
|
}
|
|
330
387
|
|
|
331
|
-
let
|
|
332
|
-
if (
|
|
333
|
-
|
|
388
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
389
|
+
if (localVarHttpContext === undefined) {
|
|
390
|
+
localVarHttpContext = new HttpContext();
|
|
334
391
|
}
|
|
335
392
|
|
|
336
|
-
|
|
393
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
394
|
+
if (localVarTransferCache === undefined) {
|
|
395
|
+
localVarTransferCache = true;
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
399
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
400
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
401
|
+
responseType_ = 'text';
|
|
402
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
403
|
+
responseType_ = 'json';
|
|
404
|
+
} else {
|
|
405
|
+
responseType_ = 'blob';
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
let localVarPath = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/zip/${this.configuration.encodeParam({ name: 'zipId', value: zipId, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
|
|
410
|
+
return this.httpClient.request<SharedCollectionZipRequest>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
411
|
+
context: localVarHttpContext,
|
|
337
412
|
responseType: <any>responseType_,
|
|
338
413
|
withCredentials: this.configuration.withCredentials,
|
|
339
|
-
headers:
|
|
414
|
+
headers: localVarHeaders,
|
|
340
415
|
observe: observe,
|
|
416
|
+
transferCache: localVarTransferCache,
|
|
341
417
|
reportProgress: reportProgress
|
|
342
418
|
});
|
|
343
419
|
}
|
|
344
420
|
|
|
345
421
|
/**
|
|
346
422
|
* Initiates the ZIP creation of a shared collection.
|
|
347
|
-
* @param
|
|
348
|
-
* @param ayPassword If shared collection has a password, this header is mandatory. Otherwise StatusCode 403 (Forbidden) is returned.
|
|
349
|
-
* @param sharedCollectionZipRequest The allowed formats are the input which could be optionally added.
|
|
423
|
+
* @param requestParameters
|
|
350
424
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
351
425
|
* @param reportProgress flag to report request and response progress.
|
|
352
426
|
*/
|
|
353
427
|
public httpSharedCollectionsRequestZipById(
|
|
354
|
-
|
|
355
|
-
ayPassword?: string,
|
|
356
|
-
sharedCollectionZipRequest?: SharedCollectionZipRequest,
|
|
428
|
+
requestParameters?: HttpSharedCollectionsRequestZipByIdRequestParams,
|
|
357
429
|
observe?: 'body',
|
|
358
430
|
reportProgress?: boolean,
|
|
359
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
431
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
360
432
|
): Observable<SharedCollectionZipRequest>;
|
|
361
433
|
public httpSharedCollectionsRequestZipById(
|
|
362
|
-
|
|
363
|
-
ayPassword?: string,
|
|
364
|
-
sharedCollectionZipRequest?: SharedCollectionZipRequest,
|
|
434
|
+
requestParameters?: HttpSharedCollectionsRequestZipByIdRequestParams,
|
|
365
435
|
observe?: 'response',
|
|
366
436
|
reportProgress?: boolean,
|
|
367
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
437
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
368
438
|
): Observable<HttpResponse<SharedCollectionZipRequest>>;
|
|
369
439
|
public httpSharedCollectionsRequestZipById(
|
|
370
|
-
|
|
371
|
-
ayPassword?: string,
|
|
372
|
-
sharedCollectionZipRequest?: SharedCollectionZipRequest,
|
|
440
|
+
requestParameters?: HttpSharedCollectionsRequestZipByIdRequestParams,
|
|
373
441
|
observe?: 'events',
|
|
374
442
|
reportProgress?: boolean,
|
|
375
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
443
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
376
444
|
): Observable<HttpEvent<SharedCollectionZipRequest>>;
|
|
377
445
|
public httpSharedCollectionsRequestZipById(
|
|
378
|
-
|
|
379
|
-
ayPassword?: string,
|
|
380
|
-
sharedCollectionZipRequest?: SharedCollectionZipRequest,
|
|
446
|
+
requestParameters?: HttpSharedCollectionsRequestZipByIdRequestParams,
|
|
381
447
|
observe: any = 'body',
|
|
382
448
|
reportProgress: boolean = false,
|
|
383
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
449
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
384
450
|
): Observable<any> {
|
|
451
|
+
const id = requestParameters?.id;
|
|
385
452
|
if (id === null || id === undefined) {
|
|
386
453
|
throw new Error('Required parameter id was null or undefined when calling httpSharedCollectionsRequestZipById.');
|
|
387
454
|
}
|
|
455
|
+
const ayPassword = requestParameters?.ayPassword;
|
|
456
|
+
const sharedCollectionZipRequest = requestParameters?.sharedCollectionZipRequest;
|
|
388
457
|
|
|
389
|
-
let
|
|
458
|
+
let localVarHeaders = this.defaultHeaders;
|
|
390
459
|
if (ayPassword !== undefined && ayPassword !== null) {
|
|
391
|
-
|
|
460
|
+
localVarHeaders = localVarHeaders.set('ay-password', String(ayPassword));
|
|
392
461
|
}
|
|
393
462
|
|
|
394
|
-
let
|
|
395
|
-
if (
|
|
463
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
464
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
396
465
|
// to determine the Accept header
|
|
397
466
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
398
|
-
|
|
467
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
468
|
+
}
|
|
469
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
470
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
474
|
+
if (localVarHttpContext === undefined) {
|
|
475
|
+
localVarHttpContext = new HttpContext();
|
|
399
476
|
}
|
|
400
|
-
|
|
401
|
-
|
|
477
|
+
|
|
478
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
479
|
+
if (localVarTransferCache === undefined) {
|
|
480
|
+
localVarTransferCache = true;
|
|
402
481
|
}
|
|
403
482
|
|
|
404
483
|
// to determine the Content-Type header
|
|
405
484
|
const consumes: string[] = ['application/json'];
|
|
406
485
|
const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes);
|
|
407
486
|
if (httpContentTypeSelected !== undefined) {
|
|
408
|
-
|
|
487
|
+
localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected);
|
|
409
488
|
}
|
|
410
489
|
|
|
411
|
-
let responseType_: 'text' | 'json' = 'json';
|
|
412
|
-
if (
|
|
413
|
-
|
|
490
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
491
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
492
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
493
|
+
responseType_ = 'text';
|
|
494
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
495
|
+
responseType_ = 'json';
|
|
496
|
+
} else {
|
|
497
|
+
responseType_ = 'blob';
|
|
498
|
+
}
|
|
414
499
|
}
|
|
415
500
|
|
|
416
|
-
|
|
501
|
+
let localVarPath = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/zip`;
|
|
502
|
+
return this.httpClient.request<SharedCollectionZipRequest>('post', `${this.configuration.basePath}${localVarPath}`, {
|
|
503
|
+
context: localVarHttpContext,
|
|
504
|
+
body: sharedCollectionZipRequest,
|
|
417
505
|
responseType: <any>responseType_,
|
|
418
506
|
withCredentials: this.configuration.withCredentials,
|
|
419
|
-
headers:
|
|
507
|
+
headers: localVarHeaders,
|
|
420
508
|
observe: observe,
|
|
509
|
+
transferCache: localVarTransferCache,
|
|
421
510
|
reportProgress: reportProgress
|
|
422
511
|
});
|
|
423
512
|
}
|