@agravity/public 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 (78) hide show
  1. package/.openapi-generator/FILES +76 -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 +43 -0
  6. package/api/publicAssetManagement.pub.agravity.ts +504 -0
  7. package/api/publicAssetOperations.pub.agravity.ts +633 -0
  8. package/api/publicAssetPublishing.pub.agravity.ts +263 -0
  9. package/api/publicAssetVersioning.pub.agravity.ts +552 -0
  10. package/api/publicAuthenticationManagement.pub.agravity.ts +135 -0
  11. package/api/publicCollectionManagement.pub.agravity.ts +562 -0
  12. package/api/publicCollectionSecureUpload.pub.agravity.ts +229 -0
  13. package/api/publicCollectionTypeManagement.pub.agravity.ts +266 -0
  14. package/api/publicConfigurationManagement.pub.agravity.ts +128 -0
  15. package/api/publicDownloadFormatManagement.pub.agravity.ts +135 -0
  16. package/api/publicGeneralManagement.pub.agravity.ts +221 -0
  17. package/api/publicHelperTools.pub.agravity.ts +288 -0
  18. package/api/publicPublishing.pub.agravity.ts +148 -0
  19. package/api/publicSavedSearch.pub.agravity.ts +148 -0
  20. package/api/publicSearchManagement.pub.agravity.ts +197 -0
  21. package/api/publicSharingManagement.pub.agravity.ts +215 -0
  22. package/api/publicSignalRConnectionManagement.pub.agravity.ts +136 -0
  23. package/api/publicStaticDefinedListManagement.pub.agravity.ts +203 -0
  24. package/api/publicTranslationManagement.pub.agravity.ts +267 -0
  25. package/api/publicWebAppData.pub.agravity.ts +193 -0
  26. package/api/publicWorkspaceManagement.pub.agravity.ts +204 -0
  27. package/api.module.ts +51 -0
  28. package/configuration.ts +132 -0
  29. package/encoder.ts +20 -0
  30. package/git_push.sh +58 -0
  31. package/index.ts +5 -0
  32. package/model/agravityErrorResponse.pub.agravity.ts +19 -0
  33. package/model/agravityVersion.pub.agravity.ts +24 -0
  34. package/model/allWebAppData.pub.agravity.ts +24 -0
  35. package/model/artificialIntelligenceGroup.pub.agravity.ts +20 -0
  36. package/model/asset.pub.agravity.ts +47 -0
  37. package/model/assetAvailability.pub.agravity.ts +19 -0
  38. package/model/assetBlob.pub.agravity.ts +82 -0
  39. package/model/assetIdContainer.pub.agravity.ts +18 -0
  40. package/model/assetPageResult.pub.agravity.ts +23 -0
  41. package/model/azSearchOptions.pub.agravity.ts +25 -0
  42. package/model/badRequestResult.pub.agravity.ts +17 -0
  43. package/model/collTypeItem.pub.agravity.ts +38 -0
  44. package/model/collection.pub.agravity.ts +35 -0
  45. package/model/collectionType.pub.agravity.ts +35 -0
  46. package/model/collectionUDL.pub.agravity.ts +21 -0
  47. package/model/createSftpUserResult.pub.agravity.ts +18 -0
  48. package/model/dataResult.pub.agravity.ts +22 -0
  49. package/model/distZipResponse.pub.agravity.ts +19 -0
  50. package/model/downloadFormat.pub.agravity.ts +34 -0
  51. package/model/dynamicImageOperation.pub.agravity.ts +18 -0
  52. package/model/entityId.pub.agravity.ts +17 -0
  53. package/model/entityIdName.pub.agravity.ts +19 -0
  54. package/model/frontendAppConfig.pub.agravity.ts +21 -0
  55. package/model/groupAllAppData.pub.agravity.ts +26 -0
  56. package/model/metadata.pub.agravity.ts +19 -0
  57. package/model/models.ts +44 -0
  58. package/model/okResult.pub.agravity.ts +17 -0
  59. package/model/publishEntity.pub.agravity.ts +28 -0
  60. package/model/publishedAsset.pub.agravity.ts +25 -0
  61. package/model/quickShareFull.pub.agravity.ts +36 -0
  62. package/model/sasToken.pub.agravity.ts +22 -0
  63. package/model/savedSearch.pub.agravity.ts +31 -0
  64. package/model/searchFacet.pub.agravity.ts +19 -0
  65. package/model/searchFacetEntity.pub.agravity.ts +19 -0
  66. package/model/searchResult.pub.agravity.ts +23 -0
  67. package/model/searchableItem.pub.agravity.ts +26 -0
  68. package/model/secureUploadEntity.pub.agravity.ts +27 -0
  69. package/model/sharedAsset.pub.agravity.ts +25 -0
  70. package/model/sharedCollectionFull.pub.agravity.ts +29 -0
  71. package/model/signalRConnectionInfo.pub.agravity.ts +18 -0
  72. package/model/staticDefinedList.pub.agravity.ts +30 -0
  73. package/model/versionEntity.pub.agravity.ts +28 -0
  74. package/model/versionedAsset.pub.agravity.ts +20 -0
  75. package/model/whereParam.pub.agravity.ts +43 -0
  76. package/model/workspace.pub.agravity.ts +34 -0
  77. package/package.json +28 -0
  78. package/variables.ts +9 -0
@@ -0,0 +1,135 @@
1
+ /**
2
+ * Agravity OpenAPI Documentation - Public Functions
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 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 { DownloadFormat } from '../model/models';
21
+
22
+ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
23
+ import { AgravityPublicConfiguration } from '../configuration';
24
+
25
+
26
+
27
+ @Injectable({
28
+ providedIn: 'root'
29
+ })
30
+ export class PublicDownloadFormatManagementService {
31
+
32
+ protected basePath = 'http://localhost:7072/api';
33
+ public defaultHeaders = new HttpHeaders();
34
+ public configuration = new AgravityPublicConfiguration();
35
+ public encoder: HttpParameterCodec;
36
+
37
+ constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: AgravityPublicConfiguration) {
38
+ if (configuration) {
39
+ this.configuration = configuration;
40
+ }
41
+ if (typeof this.configuration.basePath !== 'string') {
42
+ if (typeof basePath !== 'string') {
43
+ basePath = this.basePath;
44
+ }
45
+ this.configuration.basePath = basePath;
46
+ }
47
+ this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
48
+ }
49
+
50
+
51
+ private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
52
+ if (typeof value === "object" && value instanceof Date === false) {
53
+ httpParams = this.addToHttpParamsRecursive(httpParams, value);
54
+ } else {
55
+ httpParams = this.addToHttpParamsRecursive(httpParams, value, key);
56
+ }
57
+ return httpParams;
58
+ }
59
+
60
+ private addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
61
+ if (value == null) {
62
+ return httpParams;
63
+ }
64
+
65
+ if (typeof value === "object") {
66
+ if (Array.isArray(value)) {
67
+ (value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
68
+ } else if (value instanceof Date) {
69
+ if (key != null) {
70
+ httpParams = httpParams.append(key,
71
+ (value as Date).toISOString().substr(0, 10));
72
+ } else {
73
+ throw Error("key may not be null if value is Date");
74
+ }
75
+ } else {
76
+ Object.keys(value).forEach( k => httpParams = this.addToHttpParamsRecursive(
77
+ httpParams, value[k], key != null ? `${key}.${k}` : k));
78
+ }
79
+ } else if (key != null) {
80
+ httpParams = httpParams.append(key, value);
81
+ } else {
82
+ throw Error("key may not be null if value is not object or array");
83
+ }
84
+ return httpParams;
85
+ }
86
+
87
+ /**
88
+ * This endpoint lists all download formats in database.
89
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
90
+ * @param reportProgress flag to report request and response progress.
91
+ */
92
+ public httpDownloadFormatsGetAll(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<DownloadFormat>>;
93
+ public httpDownloadFormatsGetAll(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<DownloadFormat>>>;
94
+ public httpDownloadFormatsGetAll(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<DownloadFormat>>>;
95
+ public httpDownloadFormatsGetAll(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
96
+
97
+ let headers = this.defaultHeaders;
98
+
99
+ let credential: string | undefined;
100
+ // authentication (function_key) required
101
+ credential = this.configuration.lookupCredential('function_key');
102
+ if (credential) {
103
+ headers = headers.set('x-functions-key', credential);
104
+ }
105
+
106
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
107
+ if (httpHeaderAcceptSelected === undefined) {
108
+ // to determine the Accept header
109
+ const httpHeaderAccepts: string[] = [
110
+ 'application/json'
111
+ ];
112
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
113
+ }
114
+ if (httpHeaderAcceptSelected !== undefined) {
115
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
116
+ }
117
+
118
+
119
+ let responseType_: 'text' | 'json' = 'json';
120
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
121
+ responseType_ = 'text';
122
+ }
123
+
124
+ return this.httpClient.get<Array<DownloadFormat>>(`${this.configuration.basePath}/downloadformats`,
125
+ {
126
+ responseType: <any>responseType_,
127
+ withCredentials: this.configuration.withCredentials,
128
+ headers: headers,
129
+ observe: observe,
130
+ reportProgress: reportProgress
131
+ }
132
+ );
133
+ }
134
+
135
+ }
@@ -0,0 +1,221 @@
1
+ /**
2
+ * Agravity OpenAPI Documentation - Public Functions
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 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 { AgravityVersion } from '../model/models';
22
+ import { BadRequestResult } from '../model/models';
23
+ import { OkResult } from '../model/models';
24
+
25
+ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
26
+ import { AgravityPublicConfiguration } from '../configuration';
27
+
28
+
29
+
30
+ @Injectable({
31
+ providedIn: 'root'
32
+ })
33
+ export class PublicGeneralManagementService {
34
+
35
+ protected basePath = 'http://localhost:7072/api';
36
+ public defaultHeaders = new HttpHeaders();
37
+ public configuration = new AgravityPublicConfiguration();
38
+ public encoder: HttpParameterCodec;
39
+
40
+ constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: AgravityPublicConfiguration) {
41
+ if (configuration) {
42
+ this.configuration = configuration;
43
+ }
44
+ if (typeof this.configuration.basePath !== 'string') {
45
+ if (typeof basePath !== 'string') {
46
+ basePath = this.basePath;
47
+ }
48
+ this.configuration.basePath = basePath;
49
+ }
50
+ this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
51
+ }
52
+
53
+
54
+ private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
55
+ if (typeof value === "object" && value instanceof Date === false) {
56
+ httpParams = this.addToHttpParamsRecursive(httpParams, value);
57
+ } else {
58
+ httpParams = this.addToHttpParamsRecursive(httpParams, value, key);
59
+ }
60
+ return httpParams;
61
+ }
62
+
63
+ private addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
64
+ if (value == null) {
65
+ return httpParams;
66
+ }
67
+
68
+ if (typeof value === "object") {
69
+ if (Array.isArray(value)) {
70
+ (value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
71
+ } else if (value instanceof Date) {
72
+ if (key != null) {
73
+ httpParams = httpParams.append(key,
74
+ (value as Date).toISOString().substr(0, 10));
75
+ } else {
76
+ throw Error("key may not be null if value is Date");
77
+ }
78
+ } else {
79
+ Object.keys(value).forEach( k => httpParams = this.addToHttpParamsRecursive(
80
+ httpParams, value[k], key != null ? `${key}.${k}` : k));
81
+ }
82
+ } else if (key != null) {
83
+ httpParams = httpParams.append(key, value);
84
+ } else {
85
+ throw Error("key may not be null if value is not object or array");
86
+ }
87
+ return httpParams;
88
+ }
89
+
90
+ /**
91
+ * Get the current version of the backend. To see if backend was updated or not.
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 httpAgravityVersionInfo(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<AgravityVersion>;
96
+ public httpAgravityVersionInfo(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<AgravityVersion>>;
97
+ public httpAgravityVersionInfo(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<AgravityVersion>>;
98
+ public httpAgravityVersionInfo(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
99
+
100
+ let headers = this.defaultHeaders;
101
+
102
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
103
+ if (httpHeaderAcceptSelected === undefined) {
104
+ // to determine the Accept header
105
+ const httpHeaderAccepts: string[] = [
106
+ 'application/json'
107
+ ];
108
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
109
+ }
110
+ if (httpHeaderAcceptSelected !== undefined) {
111
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
112
+ }
113
+
114
+
115
+ let responseType_: 'text' | 'json' = 'json';
116
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
117
+ responseType_ = 'text';
118
+ }
119
+
120
+ return this.httpClient.get<AgravityVersion>(`${this.configuration.basePath}/version`,
121
+ {
122
+ responseType: <any>responseType_,
123
+ withCredentials: this.configuration.withCredentials,
124
+ headers: headers,
125
+ observe: observe,
126
+ reportProgress: reportProgress
127
+ }
128
+ );
129
+ }
130
+
131
+ /**
132
+ * Trigger the durable execution to continue
133
+ * @param instanceId The instance ID of the durable function.
134
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
135
+ * @param reportProgress flag to report request and response progress.
136
+ */
137
+ public httpTriggerDurableContinue(instanceId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<OkResult>;
138
+ public httpTriggerDurableContinue(instanceId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<OkResult>>;
139
+ public httpTriggerDurableContinue(instanceId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<OkResult>>;
140
+ public httpTriggerDurableContinue(instanceId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
141
+ if (instanceId === null || instanceId === undefined) {
142
+ throw new Error('Required parameter instanceId was null or undefined when calling httpTriggerDurableContinue.');
143
+ }
144
+
145
+ let headers = this.defaultHeaders;
146
+
147
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
148
+ if (httpHeaderAcceptSelected === undefined) {
149
+ // to determine the Accept header
150
+ const httpHeaderAccepts: string[] = [
151
+ 'application/json'
152
+ ];
153
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
154
+ }
155
+ if (httpHeaderAcceptSelected !== undefined) {
156
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
157
+ }
158
+
159
+
160
+ let responseType_: 'text' | 'json' = 'json';
161
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
162
+ responseType_ = 'text';
163
+ }
164
+
165
+ return this.httpClient.get<OkResult>(`${this.configuration.basePath}/durable/${encodeURIComponent(String(instanceId))}`,
166
+ {
167
+ responseType: <any>responseType_,
168
+ withCredentials: this.configuration.withCredentials,
169
+ headers: headers,
170
+ observe: observe,
171
+ reportProgress: reportProgress
172
+ }
173
+ );
174
+ }
175
+
176
+ /**
177
+ * Trigger the durable execution to continue
178
+ * @param instanceId The instance ID of the durable function.
179
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
180
+ * @param reportProgress flag to report request and response progress.
181
+ */
182
+ public httpTriggerDurableScchTrainingDone(instanceId: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<OkResult>;
183
+ public httpTriggerDurableScchTrainingDone(instanceId: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<OkResult>>;
184
+ public httpTriggerDurableScchTrainingDone(instanceId: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<OkResult>>;
185
+ public httpTriggerDurableScchTrainingDone(instanceId: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
186
+ if (instanceId === null || instanceId === undefined) {
187
+ throw new Error('Required parameter instanceId was null or undefined when calling httpTriggerDurableScchTrainingDone.');
188
+ }
189
+
190
+ let headers = this.defaultHeaders;
191
+
192
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
193
+ if (httpHeaderAcceptSelected === undefined) {
194
+ // to determine the Accept header
195
+ const httpHeaderAccepts: string[] = [
196
+ 'application/json'
197
+ ];
198
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
199
+ }
200
+ if (httpHeaderAcceptSelected !== undefined) {
201
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
202
+ }
203
+
204
+
205
+ let responseType_: 'text' | 'json' = 'json';
206
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
207
+ responseType_ = 'text';
208
+ }
209
+
210
+ return this.httpClient.get<OkResult>(`${this.configuration.basePath}/durable/scch/${encodeURIComponent(String(instanceId))}`,
211
+ {
212
+ responseType: <any>responseType_,
213
+ withCredentials: this.configuration.withCredentials,
214
+ headers: headers,
215
+ observe: observe,
216
+ reportProgress: reportProgress
217
+ }
218
+ );
219
+ }
220
+
221
+ }
@@ -0,0 +1,288 @@
1
+ /**
2
+ * Agravity OpenAPI Documentation - Public Functions
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 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 { CollectionUDL } from '../model/models';
21
+ import { SearchableItem } from '../model/models';
22
+
23
+ import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
24
+ import { AgravityPublicConfiguration } from '../configuration';
25
+
26
+
27
+
28
+ @Injectable({
29
+ providedIn: 'root'
30
+ })
31
+ export class PublicHelperToolsService {
32
+
33
+ protected basePath = 'http://localhost:7072/api';
34
+ public defaultHeaders = new HttpHeaders();
35
+ public configuration = new AgravityPublicConfiguration();
36
+ public encoder: HttpParameterCodec;
37
+
38
+ constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: AgravityPublicConfiguration) {
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
+ * Returns all user defined lists of all collection types
90
+ * @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \&quot;Accept-Language\&quot; header)
91
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
92
+ * @param reportProgress flag to report request and response progress.
93
+ */
94
+ public httpGetAllUserDefinedLists(translations?: boolean, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<CollectionUDL>>;
95
+ public httpGetAllUserDefinedLists(translations?: boolean, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<CollectionUDL>>>;
96
+ public httpGetAllUserDefinedLists(translations?: boolean, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<CollectionUDL>>>;
97
+ public httpGetAllUserDefinedLists(translations?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
98
+
99
+ let queryParameters = new HttpParams({encoder: this.encoder});
100
+ if (translations !== undefined && translations !== null) {
101
+ queryParameters = this.addToHttpParams(queryParameters,
102
+ <any>translations, 'translations');
103
+ }
104
+
105
+ let headers = this.defaultHeaders;
106
+
107
+ let credential: string | undefined;
108
+ // authentication (function_key) required
109
+ credential = this.configuration.lookupCredential('function_key');
110
+ if (credential) {
111
+ headers = headers.set('x-functions-key', credential);
112
+ }
113
+
114
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
115
+ if (httpHeaderAcceptSelected === undefined) {
116
+ // to determine the Accept header
117
+ const httpHeaderAccepts: string[] = [
118
+ 'application/json'
119
+ ];
120
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
121
+ }
122
+ if (httpHeaderAcceptSelected !== undefined) {
123
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
124
+ }
125
+
126
+
127
+ let responseType_: 'text' | 'json' = 'json';
128
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
129
+ responseType_ = 'text';
130
+ }
131
+
132
+ return this.httpClient.get<Array<CollectionUDL>>(`${this.configuration.basePath}/helper/userdefinedlists`,
133
+ {
134
+ params: queryParameters,
135
+ responseType: <any>responseType_,
136
+ withCredentials: this.configuration.withCredentials,
137
+ headers: headers,
138
+ observe: observe,
139
+ reportProgress: reportProgress
140
+ }
141
+ );
142
+ }
143
+
144
+ /**
145
+ * Returns all filterable items directly from the search index
146
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
147
+ * @param reportProgress flag to report request and response progress.
148
+ */
149
+ public httpGetAllowedFilterableItems(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<string>>;
150
+ public httpGetAllowedFilterableItems(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<string>>>;
151
+ public httpGetAllowedFilterableItems(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<string>>>;
152
+ public httpGetAllowedFilterableItems(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
153
+
154
+ let headers = this.defaultHeaders;
155
+
156
+ let credential: string | undefined;
157
+ // authentication (function_key) required
158
+ credential = this.configuration.lookupCredential('function_key');
159
+ if (credential) {
160
+ headers = headers.set('x-functions-key', credential);
161
+ }
162
+
163
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
164
+ if (httpHeaderAcceptSelected === undefined) {
165
+ // to determine the Accept header
166
+ const httpHeaderAccepts: string[] = [
167
+ 'application/json'
168
+ ];
169
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
170
+ }
171
+ if (httpHeaderAcceptSelected !== undefined) {
172
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
173
+ }
174
+
175
+
176
+ let responseType_: 'text' | 'json' = 'json';
177
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
178
+ responseType_ = 'text';
179
+ }
180
+
181
+ return this.httpClient.get<Array<string>>(`${this.configuration.basePath}/helper/filterableitems`,
182
+ {
183
+ responseType: <any>responseType_,
184
+ withCredentials: this.configuration.withCredentials,
185
+ headers: headers,
186
+ observe: observe,
187
+ reportProgress: reportProgress
188
+ }
189
+ );
190
+ }
191
+
192
+ /**
193
+ * Returns all searchable items directly from the search index
194
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
195
+ * @param reportProgress flag to report request and response progress.
196
+ */
197
+ public httpGetAllowedSearchableItemNames(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<string>>;
198
+ public httpGetAllowedSearchableItemNames(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<string>>>;
199
+ public httpGetAllowedSearchableItemNames(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<string>>>;
200
+ public httpGetAllowedSearchableItemNames(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
201
+
202
+ let headers = this.defaultHeaders;
203
+
204
+ let credential: string | undefined;
205
+ // authentication (function_key) required
206
+ credential = this.configuration.lookupCredential('function_key');
207
+ if (credential) {
208
+ headers = headers.set('x-functions-key', credential);
209
+ }
210
+
211
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
212
+ if (httpHeaderAcceptSelected === undefined) {
213
+ // to determine the Accept header
214
+ const httpHeaderAccepts: string[] = [
215
+ 'application/json'
216
+ ];
217
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
218
+ }
219
+ if (httpHeaderAcceptSelected !== undefined) {
220
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
221
+ }
222
+
223
+
224
+ let responseType_: 'text' | 'json' = 'json';
225
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
226
+ responseType_ = 'text';
227
+ }
228
+
229
+ return this.httpClient.get<Array<string>>(`${this.configuration.basePath}/helper/searchableitemnames`,
230
+ {
231
+ responseType: <any>responseType_,
232
+ withCredentials: this.configuration.withCredentials,
233
+ headers: headers,
234
+ observe: observe,
235
+ reportProgress: reportProgress
236
+ }
237
+ );
238
+ }
239
+
240
+ /**
241
+ * Returns all searchable items directly from the search index
242
+ * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
243
+ * @param reportProgress flag to report request and response progress.
244
+ */
245
+ public httpGetAllowedSearchableItems(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<Array<SearchableItem>>;
246
+ public httpGetAllowedSearchableItems(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpResponse<Array<SearchableItem>>>;
247
+ public httpGetAllowedSearchableItems(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable<HttpEvent<Array<SearchableItem>>>;
248
+ public httpGetAllowedSearchableItems(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json'}): Observable<any> {
249
+
250
+ let headers = this.defaultHeaders;
251
+
252
+ let credential: string | undefined;
253
+ // authentication (function_key) required
254
+ credential = this.configuration.lookupCredential('function_key');
255
+ if (credential) {
256
+ headers = headers.set('x-functions-key', credential);
257
+ }
258
+
259
+ let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
260
+ if (httpHeaderAcceptSelected === undefined) {
261
+ // to determine the Accept header
262
+ const httpHeaderAccepts: string[] = [
263
+ 'application/json'
264
+ ];
265
+ httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
266
+ }
267
+ if (httpHeaderAcceptSelected !== undefined) {
268
+ headers = headers.set('Accept', httpHeaderAcceptSelected);
269
+ }
270
+
271
+
272
+ let responseType_: 'text' | 'json' = 'json';
273
+ if(httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
274
+ responseType_ = 'text';
275
+ }
276
+
277
+ return this.httpClient.get<Array<SearchableItem>>(`${this.configuration.basePath}/helper/searchableitems`,
278
+ {
279
+ responseType: <any>responseType_,
280
+ withCredentials: this.configuration.withCredentials,
281
+ headers: headers,
282
+ observe: observe,
283
+ reportProgress: reportProgress
284
+ }
285
+ );
286
+ }
287
+
288
+ }