@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,76 @@
|
|
|
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 { SearchAdminStatus } from '../model/searchAdminStatus.pub.agravity';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { SearchFacet } from '../model/searchFacet.pub.agravity';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import { SearchResult } from '../model/searchResult.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 HttpGetSearchFacetteByNameRequestParams {
|
|
32
|
+
/** The name of the facette. */
|
|
33
|
+
name: string;
|
|
34
|
+
/** The search string which should be found. */
|
|
35
|
+
s: string;
|
|
36
|
+
/** Limits the result on all collections from the given collectiontypeid parameter. */
|
|
37
|
+
collectiontypeid?: string;
|
|
38
|
+
/** Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. */
|
|
39
|
+
collectionid?: string;
|
|
40
|
+
/** Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled) */
|
|
41
|
+
mode?: string;
|
|
42
|
+
/** Key value filter for filterable strings and string collections separated by special \',,,\'. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) */
|
|
43
|
+
filter?: string;
|
|
44
|
+
/** Comma separated values list with all ids which should be returned. */
|
|
45
|
+
ids?: string;
|
|
46
|
+
/** If the search should be redirected to a specific portal. */
|
|
47
|
+
portalId?: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface HttpGlobalSearchRequestParams {
|
|
51
|
+
/** The search string which should be found. */
|
|
52
|
+
s: string;
|
|
53
|
+
/** How many results should be returend. 0 is backend configuration limit. */
|
|
54
|
+
limit?: number;
|
|
55
|
+
/** (default: 0) - Used for paging - how many items should be skipped before next limit results will be fetched. */
|
|
56
|
+
skip?: number;
|
|
57
|
+
/** Limits the result on all collections from the given collectiontypeid parameter. */
|
|
58
|
+
collectiontypeid?: string;
|
|
59
|
+
/** Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter. */
|
|
60
|
+
collectionid?: string;
|
|
61
|
+
/** Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled) */
|
|
62
|
+
mode?: string;
|
|
63
|
+
/** This will expose the thumbnail asset blob incl. URL with SAS Token. */
|
|
64
|
+
expose?: boolean;
|
|
65
|
+
/** Colon separated key value filter for filterable strings and string collections. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled) */
|
|
66
|
+
filter?: string;
|
|
67
|
+
/** Sortable fields can be used. For descendant sorting use leading \"!\". (Only if Azure Search is enabled) */
|
|
68
|
+
orderby?: string;
|
|
69
|
+
/** Comma separated values list with all ids which should be returned. */
|
|
70
|
+
ids?: string;
|
|
71
|
+
/** If the search should be redirected to a specific portal. */
|
|
72
|
+
portalId?: string;
|
|
73
|
+
/** When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header) */
|
|
74
|
+
translations?: boolean;
|
|
75
|
+
/** The requested language of the response. If not matching it falls back to default language. */
|
|
76
|
+
acceptLanguage?: string;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface HttpSearchAdminGetStatusRequestParams {
|
|
80
|
+
/** If the search should be redirected to a specific portal. */
|
|
81
|
+
portalId?: string;
|
|
82
|
+
}
|
|
83
|
+
|
|
27
84
|
@Injectable({
|
|
28
85
|
providedIn: 'root'
|
|
29
86
|
})
|
|
@@ -35,13 +92,18 @@ export class PublicSearchManagementService {
|
|
|
35
92
|
|
|
36
93
|
constructor(
|
|
37
94
|
protected httpClient: HttpClient,
|
|
38
|
-
@Optional() @Inject(BASE_PATH) basePath: string,
|
|
95
|
+
@Optional() @Inject(BASE_PATH) basePath: string | string[],
|
|
39
96
|
@Optional() configuration: AgravityPublicConfiguration
|
|
40
97
|
) {
|
|
41
98
|
if (configuration) {
|
|
42
99
|
this.configuration = configuration;
|
|
43
100
|
}
|
|
44
101
|
if (typeof this.configuration.basePath !== 'string') {
|
|
102
|
+
const firstBasePath = Array.isArray(basePath) ? basePath[0] : undefined;
|
|
103
|
+
if (firstBasePath != undefined) {
|
|
104
|
+
basePath = firstBasePath;
|
|
105
|
+
}
|
|
106
|
+
|
|
45
107
|
if (typeof basePath !== 'string') {
|
|
46
108
|
basePath = this.basePath;
|
|
47
109
|
}
|
|
@@ -50,6 +112,7 @@ export class PublicSearchManagementService {
|
|
|
50
112
|
this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
|
|
51
113
|
}
|
|
52
114
|
|
|
115
|
+
// @ts-ignore
|
|
53
116
|
private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
|
|
54
117
|
if (typeof value === 'object' && value instanceof Date === false) {
|
|
55
118
|
httpParams = this.addToHttpParamsRecursive(httpParams, value);
|
|
@@ -69,7 +132,7 @@ export class PublicSearchManagementService {
|
|
|
69
132
|
(value as any[]).forEach((elem) => (httpParams = this.addToHttpParamsRecursive(httpParams, elem, key)));
|
|
70
133
|
} else if (value instanceof Date) {
|
|
71
134
|
if (key != null) {
|
|
72
|
-
httpParams = httpParams.append(key, (value as Date).toISOString().
|
|
135
|
+
httpParams = httpParams.append(key, (value as Date).toISOString().substring(0, 10));
|
|
73
136
|
} else {
|
|
74
137
|
throw Error('key may not be null if value is Date');
|
|
75
138
|
}
|
|
@@ -86,347 +149,355 @@ export class PublicSearchManagementService {
|
|
|
86
149
|
|
|
87
150
|
/**
|
|
88
151
|
* This endpoint returns one facette based on the search parameters.
|
|
89
|
-
* @param
|
|
90
|
-
* @param s The search string which should be found.
|
|
91
|
-
* @param collectiontypeid Limits the result on all collections from the given collectiontypeid parameter.
|
|
92
|
-
* @param collectionid Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter.
|
|
93
|
-
* @param mode Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled)
|
|
94
|
-
* @param filter Key value filter for filterable strings and string collections separated by special \',,,\'. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled)
|
|
95
|
-
* @param ids Comma separated values list with all ids which should be returned.
|
|
96
|
-
* @param portalId If the search should be redirected to a specific portal.
|
|
152
|
+
* @param requestParameters
|
|
97
153
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
98
154
|
* @param reportProgress flag to report request and response progress.
|
|
99
155
|
*/
|
|
100
156
|
public httpGetSearchFacetteByName(
|
|
101
|
-
|
|
102
|
-
s: string,
|
|
103
|
-
collectiontypeid?: string,
|
|
104
|
-
collectionid?: string,
|
|
105
|
-
mode?: string,
|
|
106
|
-
filter?: string,
|
|
107
|
-
ids?: string,
|
|
108
|
-
portalId?: string,
|
|
157
|
+
requestParameters?: HttpGetSearchFacetteByNameRequestParams,
|
|
109
158
|
observe?: 'body',
|
|
110
159
|
reportProgress?: boolean,
|
|
111
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
160
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
112
161
|
): Observable<SearchFacet>;
|
|
113
162
|
public httpGetSearchFacetteByName(
|
|
114
|
-
|
|
115
|
-
s: string,
|
|
116
|
-
collectiontypeid?: string,
|
|
117
|
-
collectionid?: string,
|
|
118
|
-
mode?: string,
|
|
119
|
-
filter?: string,
|
|
120
|
-
ids?: string,
|
|
121
|
-
portalId?: string,
|
|
163
|
+
requestParameters?: HttpGetSearchFacetteByNameRequestParams,
|
|
122
164
|
observe?: 'response',
|
|
123
165
|
reportProgress?: boolean,
|
|
124
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
166
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
125
167
|
): Observable<HttpResponse<SearchFacet>>;
|
|
126
168
|
public httpGetSearchFacetteByName(
|
|
127
|
-
|
|
128
|
-
s: string,
|
|
129
|
-
collectiontypeid?: string,
|
|
130
|
-
collectionid?: string,
|
|
131
|
-
mode?: string,
|
|
132
|
-
filter?: string,
|
|
133
|
-
ids?: string,
|
|
134
|
-
portalId?: string,
|
|
169
|
+
requestParameters?: HttpGetSearchFacetteByNameRequestParams,
|
|
135
170
|
observe?: 'events',
|
|
136
171
|
reportProgress?: boolean,
|
|
137
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
172
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
138
173
|
): Observable<HttpEvent<SearchFacet>>;
|
|
139
174
|
public httpGetSearchFacetteByName(
|
|
140
|
-
|
|
141
|
-
s: string,
|
|
142
|
-
collectiontypeid?: string,
|
|
143
|
-
collectionid?: string,
|
|
144
|
-
mode?: string,
|
|
145
|
-
filter?: string,
|
|
146
|
-
ids?: string,
|
|
147
|
-
portalId?: string,
|
|
175
|
+
requestParameters?: HttpGetSearchFacetteByNameRequestParams,
|
|
148
176
|
observe: any = 'body',
|
|
149
177
|
reportProgress: boolean = false,
|
|
150
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
178
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
151
179
|
): Observable<any> {
|
|
180
|
+
const name = requestParameters?.name;
|
|
152
181
|
if (name === null || name === undefined) {
|
|
153
182
|
throw new Error('Required parameter name was null or undefined when calling httpGetSearchFacetteByName.');
|
|
154
183
|
}
|
|
184
|
+
const s = requestParameters?.s;
|
|
155
185
|
if (s === null || s === undefined) {
|
|
156
186
|
throw new Error('Required parameter s was null or undefined when calling httpGetSearchFacetteByName.');
|
|
157
187
|
}
|
|
188
|
+
const collectiontypeid = requestParameters?.collectiontypeid;
|
|
189
|
+
const collectionid = requestParameters?.collectionid;
|
|
190
|
+
const mode = requestParameters?.mode;
|
|
191
|
+
const filter = requestParameters?.filter;
|
|
192
|
+
const ids = requestParameters?.ids;
|
|
193
|
+
const portalId = requestParameters?.portalId;
|
|
158
194
|
|
|
159
|
-
let
|
|
195
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
160
196
|
if (name !== undefined && name !== null) {
|
|
161
|
-
|
|
197
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>name, 'name');
|
|
162
198
|
}
|
|
163
199
|
if (s !== undefined && s !== null) {
|
|
164
|
-
|
|
200
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>s, 's');
|
|
165
201
|
}
|
|
166
202
|
if (collectiontypeid !== undefined && collectiontypeid !== null) {
|
|
167
|
-
|
|
203
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectiontypeid, 'collectiontypeid');
|
|
168
204
|
}
|
|
169
205
|
if (collectionid !== undefined && collectionid !== null) {
|
|
170
|
-
|
|
206
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectionid, 'collectionid');
|
|
171
207
|
}
|
|
172
208
|
if (mode !== undefined && mode !== null) {
|
|
173
|
-
|
|
209
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>mode, 'mode');
|
|
174
210
|
}
|
|
175
211
|
if (filter !== undefined && filter !== null) {
|
|
176
|
-
|
|
212
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>filter, 'filter');
|
|
177
213
|
}
|
|
178
214
|
if (ids !== undefined && ids !== null) {
|
|
179
|
-
|
|
215
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>ids, 'ids');
|
|
180
216
|
}
|
|
181
217
|
if (portalId !== undefined && portalId !== null) {
|
|
182
|
-
|
|
218
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>portalId, 'portal_id');
|
|
183
219
|
}
|
|
184
220
|
|
|
185
|
-
let
|
|
221
|
+
let localVarHeaders = this.defaultHeaders;
|
|
186
222
|
|
|
187
|
-
let
|
|
223
|
+
let localVarCredential: string | undefined;
|
|
188
224
|
// authentication (function_key) required
|
|
189
|
-
|
|
190
|
-
if (
|
|
191
|
-
|
|
225
|
+
localVarCredential = this.configuration.lookupCredential('function_key');
|
|
226
|
+
if (localVarCredential) {
|
|
227
|
+
localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
|
|
192
228
|
}
|
|
193
229
|
|
|
194
|
-
let
|
|
195
|
-
if (
|
|
230
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
231
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
196
232
|
// to determine the Accept header
|
|
197
233
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
198
|
-
|
|
234
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
199
235
|
}
|
|
200
|
-
if (
|
|
201
|
-
|
|
236
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
237
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
241
|
+
if (localVarHttpContext === undefined) {
|
|
242
|
+
localVarHttpContext = new HttpContext();
|
|
202
243
|
}
|
|
203
244
|
|
|
204
|
-
let
|
|
205
|
-
if (
|
|
206
|
-
|
|
245
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
246
|
+
if (localVarTransferCache === undefined) {
|
|
247
|
+
localVarTransferCache = true;
|
|
207
248
|
}
|
|
208
249
|
|
|
209
|
-
|
|
210
|
-
|
|
250
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
251
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
252
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
253
|
+
responseType_ = 'text';
|
|
254
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
255
|
+
responseType_ = 'json';
|
|
256
|
+
} else {
|
|
257
|
+
responseType_ = 'blob';
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
let localVarPath = `/search/facette`;
|
|
262
|
+
return this.httpClient.request<SearchFacet>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
263
|
+
context: localVarHttpContext,
|
|
264
|
+
params: localVarQueryParameters,
|
|
211
265
|
responseType: <any>responseType_,
|
|
212
266
|
withCredentials: this.configuration.withCredentials,
|
|
213
|
-
headers:
|
|
267
|
+
headers: localVarHeaders,
|
|
214
268
|
observe: observe,
|
|
269
|
+
transferCache: localVarTransferCache,
|
|
215
270
|
reportProgress: reportProgress
|
|
216
271
|
});
|
|
217
272
|
}
|
|
218
273
|
|
|
219
274
|
/**
|
|
220
275
|
* This endpoint returns a configured max amount of results for search terms.
|
|
221
|
-
* @param
|
|
222
|
-
* @param limit How many results should be returend. 0 is backend configuration limit.
|
|
223
|
-
* @param skip (default: 0) - Used for paging - how many items should be skipped before next limit results will be fetched.
|
|
224
|
-
* @param collectiontypeid Limits the result on all collections from the given collectiontypeid parameter.
|
|
225
|
-
* @param collectionid Limits the result on collection id (and siblings). Will be overwritten by collectiontypeid parameter.
|
|
226
|
-
* @param mode Two modes supported: \"any\" or \"all\" search terms should be applied. (Only if Azure Search is enabled)
|
|
227
|
-
* @param expose This will expose the thumbnail asset blob incl. URL with SAS Token.
|
|
228
|
-
* @param filter Colon separated key value filter for filterable strings and string collections. For date or numbers \"<\", \"=\" and \">\" are possible. Mode influences AND (all) and OR (any) of all filters. Multiple filters are separated by semicolons. (Only if Azure Search is enabled)
|
|
229
|
-
* @param orderby Sortable fields can be used. For descendant sorting use leading \"!\". (Only if Azure Search is enabled)
|
|
230
|
-
* @param ids Comma separated values list with all ids which should be returned.
|
|
231
|
-
* @param portalId If the search should be redirected to a specific portal.
|
|
232
|
-
* @param translations When default language should be returned and the translation dictionary is delivered. (Ignores the \"Accept-Language\" header)
|
|
276
|
+
* @param requestParameters
|
|
233
277
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
234
278
|
* @param reportProgress flag to report request and response progress.
|
|
235
279
|
*/
|
|
236
280
|
public httpGlobalSearch(
|
|
237
|
-
|
|
238
|
-
limit?: number,
|
|
239
|
-
skip?: number,
|
|
240
|
-
collectiontypeid?: string,
|
|
241
|
-
collectionid?: string,
|
|
242
|
-
mode?: string,
|
|
243
|
-
expose?: boolean,
|
|
244
|
-
filter?: string,
|
|
245
|
-
orderby?: string,
|
|
246
|
-
ids?: string,
|
|
247
|
-
portalId?: string,
|
|
248
|
-
translations?: boolean,
|
|
281
|
+
requestParameters?: HttpGlobalSearchRequestParams,
|
|
249
282
|
observe?: 'body',
|
|
250
283
|
reportProgress?: boolean,
|
|
251
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
284
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
252
285
|
): Observable<SearchResult>;
|
|
253
286
|
public httpGlobalSearch(
|
|
254
|
-
|
|
255
|
-
limit?: number,
|
|
256
|
-
skip?: number,
|
|
257
|
-
collectiontypeid?: string,
|
|
258
|
-
collectionid?: string,
|
|
259
|
-
mode?: string,
|
|
260
|
-
expose?: boolean,
|
|
261
|
-
filter?: string,
|
|
262
|
-
orderby?: string,
|
|
263
|
-
ids?: string,
|
|
264
|
-
portalId?: string,
|
|
265
|
-
translations?: boolean,
|
|
287
|
+
requestParameters?: HttpGlobalSearchRequestParams,
|
|
266
288
|
observe?: 'response',
|
|
267
289
|
reportProgress?: boolean,
|
|
268
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
290
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
269
291
|
): Observable<HttpResponse<SearchResult>>;
|
|
270
292
|
public httpGlobalSearch(
|
|
271
|
-
|
|
272
|
-
limit?: number,
|
|
273
|
-
skip?: number,
|
|
274
|
-
collectiontypeid?: string,
|
|
275
|
-
collectionid?: string,
|
|
276
|
-
mode?: string,
|
|
277
|
-
expose?: boolean,
|
|
278
|
-
filter?: string,
|
|
279
|
-
orderby?: string,
|
|
280
|
-
ids?: string,
|
|
281
|
-
portalId?: string,
|
|
282
|
-
translations?: boolean,
|
|
293
|
+
requestParameters?: HttpGlobalSearchRequestParams,
|
|
283
294
|
observe?: 'events',
|
|
284
295
|
reportProgress?: boolean,
|
|
285
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
296
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
286
297
|
): Observable<HttpEvent<SearchResult>>;
|
|
287
298
|
public httpGlobalSearch(
|
|
288
|
-
|
|
289
|
-
limit?: number,
|
|
290
|
-
skip?: number,
|
|
291
|
-
collectiontypeid?: string,
|
|
292
|
-
collectionid?: string,
|
|
293
|
-
mode?: string,
|
|
294
|
-
expose?: boolean,
|
|
295
|
-
filter?: string,
|
|
296
|
-
orderby?: string,
|
|
297
|
-
ids?: string,
|
|
298
|
-
portalId?: string,
|
|
299
|
-
translations?: boolean,
|
|
299
|
+
requestParameters?: HttpGlobalSearchRequestParams,
|
|
300
300
|
observe: any = 'body',
|
|
301
301
|
reportProgress: boolean = false,
|
|
302
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
302
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
303
303
|
): Observable<any> {
|
|
304
|
+
const s = requestParameters?.s;
|
|
304
305
|
if (s === null || s === undefined) {
|
|
305
306
|
throw new Error('Required parameter s was null or undefined when calling httpGlobalSearch.');
|
|
306
307
|
}
|
|
308
|
+
const limit = requestParameters?.limit;
|
|
309
|
+
const skip = requestParameters?.skip;
|
|
310
|
+
const collectiontypeid = requestParameters?.collectiontypeid;
|
|
311
|
+
const collectionid = requestParameters?.collectionid;
|
|
312
|
+
const mode = requestParameters?.mode;
|
|
313
|
+
const expose = requestParameters?.expose;
|
|
314
|
+
const filter = requestParameters?.filter;
|
|
315
|
+
const orderby = requestParameters?.orderby;
|
|
316
|
+
const ids = requestParameters?.ids;
|
|
317
|
+
const portalId = requestParameters?.portalId;
|
|
318
|
+
const translations = requestParameters?.translations;
|
|
319
|
+
const acceptLanguage = requestParameters?.acceptLanguage;
|
|
307
320
|
|
|
308
|
-
let
|
|
321
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
309
322
|
if (s !== undefined && s !== null) {
|
|
310
|
-
|
|
323
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>s, 's');
|
|
311
324
|
}
|
|
312
325
|
if (limit !== undefined && limit !== null) {
|
|
313
|
-
|
|
326
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>limit, 'limit');
|
|
314
327
|
}
|
|
315
328
|
if (skip !== undefined && skip !== null) {
|
|
316
|
-
|
|
329
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>skip, 'skip');
|
|
317
330
|
}
|
|
318
331
|
if (collectiontypeid !== undefined && collectiontypeid !== null) {
|
|
319
|
-
|
|
332
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectiontypeid, 'collectiontypeid');
|
|
320
333
|
}
|
|
321
334
|
if (collectionid !== undefined && collectionid !== null) {
|
|
322
|
-
|
|
335
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectionid, 'collectionid');
|
|
323
336
|
}
|
|
324
337
|
if (mode !== undefined && mode !== null) {
|
|
325
|
-
|
|
338
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>mode, 'mode');
|
|
326
339
|
}
|
|
327
340
|
if (expose !== undefined && expose !== null) {
|
|
328
|
-
|
|
341
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>expose, 'expose');
|
|
329
342
|
}
|
|
330
343
|
if (filter !== undefined && filter !== null) {
|
|
331
|
-
|
|
344
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>filter, 'filter');
|
|
332
345
|
}
|
|
333
346
|
if (orderby !== undefined && orderby !== null) {
|
|
334
|
-
|
|
347
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>orderby, 'orderby');
|
|
335
348
|
}
|
|
336
349
|
if (ids !== undefined && ids !== null) {
|
|
337
|
-
|
|
350
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>ids, 'ids');
|
|
338
351
|
}
|
|
339
352
|
if (portalId !== undefined && portalId !== null) {
|
|
340
|
-
|
|
353
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>portalId, 'portal_id');
|
|
341
354
|
}
|
|
342
355
|
if (translations !== undefined && translations !== null) {
|
|
343
|
-
|
|
356
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>translations, 'translations');
|
|
344
357
|
}
|
|
345
358
|
|
|
346
|
-
let
|
|
359
|
+
let localVarHeaders = this.defaultHeaders;
|
|
360
|
+
if (acceptLanguage !== undefined && acceptLanguage !== null) {
|
|
361
|
+
localVarHeaders = localVarHeaders.set('Accept-Language', String(acceptLanguage));
|
|
362
|
+
}
|
|
347
363
|
|
|
348
|
-
let
|
|
364
|
+
let localVarCredential: string | undefined;
|
|
349
365
|
// authentication (function_key) required
|
|
350
|
-
|
|
351
|
-
if (
|
|
352
|
-
|
|
366
|
+
localVarCredential = this.configuration.lookupCredential('function_key');
|
|
367
|
+
if (localVarCredential) {
|
|
368
|
+
localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
|
|
353
369
|
}
|
|
354
370
|
|
|
355
|
-
let
|
|
356
|
-
if (
|
|
371
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
372
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
357
373
|
// to determine the Accept header
|
|
358
374
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
359
|
-
|
|
375
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
360
376
|
}
|
|
361
|
-
if (
|
|
362
|
-
|
|
377
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
378
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
382
|
+
if (localVarHttpContext === undefined) {
|
|
383
|
+
localVarHttpContext = new HttpContext();
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
387
|
+
if (localVarTransferCache === undefined) {
|
|
388
|
+
localVarTransferCache = true;
|
|
363
389
|
}
|
|
364
390
|
|
|
365
|
-
let responseType_: 'text' | 'json' = 'json';
|
|
366
|
-
if (
|
|
367
|
-
|
|
391
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
392
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
393
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
394
|
+
responseType_ = 'text';
|
|
395
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
396
|
+
responseType_ = 'json';
|
|
397
|
+
} else {
|
|
398
|
+
responseType_ = 'blob';
|
|
399
|
+
}
|
|
368
400
|
}
|
|
369
401
|
|
|
370
|
-
|
|
371
|
-
|
|
402
|
+
let localVarPath = `/search`;
|
|
403
|
+
return this.httpClient.request<SearchResult>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
404
|
+
context: localVarHttpContext,
|
|
405
|
+
params: localVarQueryParameters,
|
|
372
406
|
responseType: <any>responseType_,
|
|
373
407
|
withCredentials: this.configuration.withCredentials,
|
|
374
|
-
headers:
|
|
408
|
+
headers: localVarHeaders,
|
|
375
409
|
observe: observe,
|
|
410
|
+
transferCache: localVarTransferCache,
|
|
376
411
|
reportProgress: reportProgress
|
|
377
412
|
});
|
|
378
413
|
}
|
|
379
414
|
|
|
380
415
|
/**
|
|
381
416
|
* This endpoint gives the status about the index and indexer.
|
|
382
|
-
* @param
|
|
417
|
+
* @param requestParameters
|
|
383
418
|
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
|
|
384
419
|
* @param reportProgress flag to report request and response progress.
|
|
385
420
|
*/
|
|
386
|
-
public httpSearchAdminGetStatus(portalId?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json' }): Observable<SearchAdminStatus>;
|
|
387
421
|
public httpSearchAdminGetStatus(
|
|
388
|
-
|
|
422
|
+
requestParameters?: HttpSearchAdminGetStatusRequestParams,
|
|
423
|
+
observe?: 'body',
|
|
424
|
+
reportProgress?: boolean,
|
|
425
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
426
|
+
): Observable<SearchAdminStatus>;
|
|
427
|
+
public httpSearchAdminGetStatus(
|
|
428
|
+
requestParameters?: HttpSearchAdminGetStatusRequestParams,
|
|
389
429
|
observe?: 'response',
|
|
390
430
|
reportProgress?: boolean,
|
|
391
|
-
options?: { httpHeaderAccept?: 'application/json' }
|
|
431
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
392
432
|
): Observable<HttpResponse<SearchAdminStatus>>;
|
|
393
|
-
public httpSearchAdminGetStatus(
|
|
394
|
-
|
|
395
|
-
|
|
433
|
+
public httpSearchAdminGetStatus(
|
|
434
|
+
requestParameters?: HttpSearchAdminGetStatusRequestParams,
|
|
435
|
+
observe?: 'events',
|
|
436
|
+
reportProgress?: boolean,
|
|
437
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
438
|
+
): Observable<HttpEvent<SearchAdminStatus>>;
|
|
439
|
+
public httpSearchAdminGetStatus(
|
|
440
|
+
requestParameters?: HttpSearchAdminGetStatusRequestParams,
|
|
441
|
+
observe: any = 'body',
|
|
442
|
+
reportProgress: boolean = false,
|
|
443
|
+
options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
|
|
444
|
+
): Observable<any> {
|
|
445
|
+
const portalId = requestParameters?.portalId;
|
|
446
|
+
|
|
447
|
+
let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
|
|
396
448
|
if (portalId !== undefined && portalId !== null) {
|
|
397
|
-
|
|
449
|
+
localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>portalId, 'portal_id');
|
|
398
450
|
}
|
|
399
451
|
|
|
400
|
-
let
|
|
452
|
+
let localVarHeaders = this.defaultHeaders;
|
|
401
453
|
|
|
402
|
-
let
|
|
454
|
+
let localVarCredential: string | undefined;
|
|
403
455
|
// authentication (function_key) required
|
|
404
|
-
|
|
405
|
-
if (
|
|
406
|
-
|
|
456
|
+
localVarCredential = this.configuration.lookupCredential('function_key');
|
|
457
|
+
if (localVarCredential) {
|
|
458
|
+
localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
|
|
407
459
|
}
|
|
408
460
|
|
|
409
|
-
let
|
|
410
|
-
if (
|
|
461
|
+
let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
|
|
462
|
+
if (localVarHttpHeaderAcceptSelected === undefined) {
|
|
411
463
|
// to determine the Accept header
|
|
412
464
|
const httpHeaderAccepts: string[] = ['application/json'];
|
|
413
|
-
|
|
465
|
+
localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
|
|
414
466
|
}
|
|
415
|
-
if (
|
|
416
|
-
|
|
467
|
+
if (localVarHttpHeaderAcceptSelected !== undefined) {
|
|
468
|
+
localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
let localVarHttpContext: HttpContext | undefined = options && options.context;
|
|
472
|
+
if (localVarHttpContext === undefined) {
|
|
473
|
+
localVarHttpContext = new HttpContext();
|
|
417
474
|
}
|
|
418
475
|
|
|
419
|
-
let
|
|
420
|
-
if (
|
|
421
|
-
|
|
476
|
+
let localVarTransferCache: boolean | undefined = options && options.transferCache;
|
|
477
|
+
if (localVarTransferCache === undefined) {
|
|
478
|
+
localVarTransferCache = true;
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
let responseType_: 'text' | 'json' | 'blob' = 'json';
|
|
482
|
+
if (localVarHttpHeaderAcceptSelected) {
|
|
483
|
+
if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
|
|
484
|
+
responseType_ = 'text';
|
|
485
|
+
} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
|
|
486
|
+
responseType_ = 'json';
|
|
487
|
+
} else {
|
|
488
|
+
responseType_ = 'blob';
|
|
489
|
+
}
|
|
422
490
|
}
|
|
423
491
|
|
|
424
|
-
|
|
425
|
-
|
|
492
|
+
let localVarPath = `/searchadmin/status`;
|
|
493
|
+
return this.httpClient.request<SearchAdminStatus>('get', `${this.configuration.basePath}${localVarPath}`, {
|
|
494
|
+
context: localVarHttpContext,
|
|
495
|
+
params: localVarQueryParameters,
|
|
426
496
|
responseType: <any>responseType_,
|
|
427
497
|
withCredentials: this.configuration.withCredentials,
|
|
428
|
-
headers:
|
|
498
|
+
headers: localVarHeaders,
|
|
429
499
|
observe: observe,
|
|
500
|
+
transferCache: localVarTransferCache,
|
|
430
501
|
reportProgress: reportProgress
|
|
431
502
|
});
|
|
432
503
|
}
|