@agravity/public 7.3.1 → 8.1.0

package/api/publicTranslationManagement.pub.agravity.ts

@@ -2,7 +2,6 @@
  * Agravity OpenAPI Documentation - Public Functions
  * <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
  *
- * The version of the OpenAPI document: 7.3.1
  * Contact: office@agravity.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,15 +11,40 @@
 /* tslint:disable:no-unused-variable member-ordering */
 
 import { Inject, Injectable, Optional } from '@angular/core';
-import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParameterCodec } from '@angular/common/http';
+import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
 import { CustomHttpParameterCodec } from '../encoder';
 import { Observable } from 'rxjs';
 
-import { AgravityErrorResponse } from '../model/models';
+// @ts-ignore
+import { AgravityErrorResponse } from '../model/agravityErrorResponse.pub.agravity';
 
+// @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
 import { AgravityPublicConfiguration } from '../configuration';
 
+export interface HttpTranslationsByIdRequestParams {
+	/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format). */
+	id: string;
+	/** If the items should be included (only for entity type Collection and Asset). */
+	items?: boolean;
+}
+
+export interface HttpTranslationsByIdFilterByCustomFieldRequestParams {
+	/** The ID of only translateable entities with custom fields (Asset, Collection). */
+	id: string;
+	/** Limit the output to a specific custom field key. */
+	customField: string;
+}
+
+export interface HttpTranslationsByIdFilterByPropertyRequestParams {
+	/** The ID of any translateable entity (Asset, Collection, Collection Type, Download Format). */
+	id: string;
+	/** Limit to one specific property (key) */
+	property: string;
+	/** If the items should be included (only for entity type Collection and Asset). */
+	items?: boolean;
+}
+
 @Injectable({
 	providedIn: 'root'
 })
@@ -32,13 +56,18 @@ export class PublicTranslationManagementService {
 
 	constructor(
 		protected httpClient: HttpClient,
-		@Optional() @Inject(BASE_PATH) basePath: string,
+		@Optional() @Inject(BASE_PATH) basePath: string | string[],
 		@Optional() configuration: AgravityPublicConfiguration
 	) {
 		if (configuration) {
 			this.configuration = configuration;
 		}
 		if (typeof this.configuration.basePath !== 'string') {
+			const firstBasePath = Array.isArray(basePath) ? basePath[0] : undefined;
+			if (firstBasePath != undefined) {
+				basePath = firstBasePath;
+			}
+
 			if (typeof basePath !== 'string') {
 				basePath = this.basePath;
 			}
@@ -47,6 +76,7 @@ export class PublicTranslationManagementService {
 		this.encoder = this.configuration.encoder || new CustomHttpParameterCodec();
 	}
 
+	// @ts-ignore
 	private addToHttpParams(httpParams: HttpParams, value: any, key?: string): HttpParams {
 		if (typeof value === 'object' && value instanceof Date === false) {
 			httpParams = this.addToHttpParamsRecursive(httpParams, value);
@@ -66,7 +96,7 @@ export class PublicTranslationManagementService {
 				(value as any[]).forEach((elem) => (httpParams = this.addToHttpParamsRecursive(httpParams, elem, key)));
 			} else if (value instanceof Date) {
 				if (key != null) {
-					httpParams = httpParams.append(key, (value as Date).toISOString().substr(0, 10));
+					httpParams = httpParams.append(key, (value as Date).toISOString().substring(0, 10));
 				} else {
 					throw Error('key may not be null if value is Date');
 				}
@@ -83,240 +113,284 @@ export class PublicTranslationManagementService {
 
 	/**
 	 * Get all the translations of a whole entity (Asset, Collection, Collection Type, Download Format)
-	 * @param id The ID of any translateable entity (Asset, Collection, Collection Type, Download Format).
-	 * @param items If the items should be included (only for entity type Collection and Asset).
+	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
 	 * @param reportProgress flag to report request and response progress.
 	 */
 	public httpTranslationsById(
-		id: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdRequestParams,
 		observe?: 'body',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<{ [key: string]: { [key: string]: object } }>;
 	public httpTranslationsById(
-		id: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdRequestParams,
 		observe?: 'response',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpResponse<{ [key: string]: { [key: string]: object } }>>;
 	public httpTranslationsById(
-		id: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdRequestParams,
 		observe?: 'events',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpEvent<{ [key: string]: { [key: string]: object } }>>;
-	public httpTranslationsById(id: string, items?: boolean, observe: any = 'body', reportProgress: boolean = false, options?: { httpHeaderAccept?: 'application/json' }): Observable<any> {
+	public httpTranslationsById(
+		requestParameters?: HttpTranslationsByIdRequestParams,
+		observe: any = 'body',
+		reportProgress: boolean = false,
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
+	): Observable<any> {
+		const id = requestParameters?.id;
 		if (id === null || id === undefined) {
 			throw new Error('Required parameter id was null or undefined when calling httpTranslationsById.');
 		}
+		const items = requestParameters?.items;
 
-		let queryParameters = new HttpParams({ encoder: this.encoder });
+		let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
 		if (items !== undefined && items !== null) {
-			queryParameters = this.addToHttpParams(queryParameters, <any>items, 'items');
+			localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>items, 'items');
 		}
 
-		let headers = this.defaultHeaders;
+		let localVarHeaders = this.defaultHeaders;
 
-		let credential: string | undefined;
+		let localVarCredential: string | undefined;
 		// authentication (function_key) required
-		credential = this.configuration.lookupCredential('function_key');
-		if (credential) {
-			headers = headers.set('x-functions-key', credential);
+		localVarCredential = this.configuration.lookupCredential('function_key');
+		if (localVarCredential) {
+			localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
 		}
 
-		let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
-		if (httpHeaderAcceptSelected === undefined) {
+		let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
+		if (localVarHttpHeaderAcceptSelected === undefined) {
 			// to determine the Accept header
 			const httpHeaderAccepts: string[] = ['application/json'];
-			httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+			localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
 		}
-		if (httpHeaderAcceptSelected !== undefined) {
-			headers = headers.set('Accept', httpHeaderAcceptSelected);
+		if (localVarHttpHeaderAcceptSelected !== undefined) {
+			localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
 		}
 
-		let responseType_: 'text' | 'json' = 'json';
-		if (httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
-			responseType_ = 'text';
+		let localVarHttpContext: HttpContext | undefined = options && options.context;
+		if (localVarHttpContext === undefined) {
+			localVarHttpContext = new HttpContext();
 		}
 
-		return this.httpClient.get<{ [key: string]: { [key: string]: object } }>(`${this.configuration.basePath}/translations/${encodeURIComponent(String(id))}`, {
-			params: queryParameters,
+		let localVarTransferCache: boolean | undefined = options && options.transferCache;
+		if (localVarTransferCache === undefined) {
+			localVarTransferCache = true;
+		}
+
+		let responseType_: 'text' | 'json' | 'blob' = 'json';
+		if (localVarHttpHeaderAcceptSelected) {
+			if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+				responseType_ = 'text';
+			} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+				responseType_ = 'json';
+			} else {
+				responseType_ = 'blob';
+			}
+		}
+
+		let localVarPath = `/translations/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
+		return this.httpClient.request<{ [key: string]: { [key: string]: object } }>('get', `${this.configuration.basePath}${localVarPath}`, {
+			context: localVarHttpContext,
+			params: localVarQueryParameters,
 			responseType: <any>responseType_,
 			withCredentials: this.configuration.withCredentials,
-			headers: headers,
+			headers: localVarHeaders,
 			observe: observe,
+			transferCache: localVarTransferCache,
 			reportProgress: reportProgress
 		});
 	}
 
 	/**
 	 * Get the translation of custom field on the entity (Asset, Collection)
-	 * @param id The ID of only translateable entities with custom fields (Asset, Collection).
-	 * @param customField Limit the output to a specific custom field key.
+	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
 	 * @param reportProgress flag to report request and response progress.
 	 */
 	public httpTranslationsByIdFilterByCustomField(
-		id: string,
-		customField: string,
+		requestParameters?: HttpTranslationsByIdFilterByCustomFieldRequestParams,
 		observe?: 'body',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<{ [key: string]: { [key: string]: object } }>;
 	public httpTranslationsByIdFilterByCustomField(
-		id: string,
-		customField: string,
+		requestParameters?: HttpTranslationsByIdFilterByCustomFieldRequestParams,
 		observe?: 'response',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpResponse<{ [key: string]: { [key: string]: object } }>>;
 	public httpTranslationsByIdFilterByCustomField(
-		id: string,
-		customField: string,
+		requestParameters?: HttpTranslationsByIdFilterByCustomFieldRequestParams,
 		observe?: 'events',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpEvent<{ [key: string]: { [key: string]: object } }>>;
 	public httpTranslationsByIdFilterByCustomField(
-		id: string,
-		customField: string,
+		requestParameters?: HttpTranslationsByIdFilterByCustomFieldRequestParams,
 		observe: any = 'body',
 		reportProgress: boolean = false,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<any> {
+		const id = requestParameters?.id;
 		if (id === null || id === undefined) {
 			throw new Error('Required parameter id was null or undefined when calling httpTranslationsByIdFilterByCustomField.');
 		}
+		const customField = requestParameters?.customField;
 		if (customField === null || customField === undefined) {
 			throw new Error('Required parameter customField was null or undefined when calling httpTranslationsByIdFilterByCustomField.');
 		}
 
-		let headers = this.defaultHeaders;
+		let localVarHeaders = this.defaultHeaders;
 
-		let credential: string | undefined;
+		let localVarCredential: string | undefined;
 		// authentication (function_key) required
-		credential = this.configuration.lookupCredential('function_key');
-		if (credential) {
-			headers = headers.set('x-functions-key', credential);
+		localVarCredential = this.configuration.lookupCredential('function_key');
+		if (localVarCredential) {
+			localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
 		}
 
-		let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
-		if (httpHeaderAcceptSelected === undefined) {
+		let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
+		if (localVarHttpHeaderAcceptSelected === undefined) {
 			// to determine the Accept header
 			const httpHeaderAccepts: string[] = ['application/json'];
-			httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+			localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+		}
+		if (localVarHttpHeaderAcceptSelected !== undefined) {
+			localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
 		}
-		if (httpHeaderAcceptSelected !== undefined) {
-			headers = headers.set('Accept', httpHeaderAcceptSelected);
+
+		let localVarHttpContext: HttpContext | undefined = options && options.context;
+		if (localVarHttpContext === undefined) {
+			localVarHttpContext = new HttpContext();
 		}
 
-		let responseType_: 'text' | 'json' = 'json';
-		if (httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
-			responseType_ = 'text';
+		let localVarTransferCache: boolean | undefined = options && options.transferCache;
+		if (localVarTransferCache === undefined) {
+			localVarTransferCache = true;
 		}
 
-		return this.httpClient.get<{ [key: string]: { [key: string]: object } }>(
-			`${this.configuration.basePath}/translations/${encodeURIComponent(String(id))}/custom/${encodeURIComponent(String(customField))}`,
-			{
-				responseType: <any>responseType_,
-				withCredentials: this.configuration.withCredentials,
-				headers: headers,
-				observe: observe,
-				reportProgress: reportProgress
+		let responseType_: 'text' | 'json' | 'blob' = 'json';
+		if (localVarHttpHeaderAcceptSelected) {
+			if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+				responseType_ = 'text';
+			} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+				responseType_ = 'json';
+			} else {
+				responseType_ = 'blob';
 			}
-		);
+		}
+
+		let localVarPath = `/translations/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/custom/${this.configuration.encodeParam({ name: 'customField', value: customField, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
+		return this.httpClient.request<{ [key: string]: { [key: string]: object } }>('get', `${this.configuration.basePath}${localVarPath}`, {
+			context: localVarHttpContext,
+			responseType: <any>responseType_,
+			withCredentials: this.configuration.withCredentials,
+			headers: localVarHeaders,
+			observe: observe,
+			transferCache: localVarTransferCache,
+			reportProgress: reportProgress
+		});
 	}
 
 	/**
 	 * Get the translations of a specific field on the entity (Asset, Collection, Collection Type, Download Format)
-	 * @param id The ID of any translateable entity (Asset, Collection, Collection Type, Download Format).
-	 * @param property Limit to one specific property (key)
-	 * @param items If the items should be included (only for entity type Collection and Asset).
+	 * @param requestParameters
 	 * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
 	 * @param reportProgress flag to report request and response progress.
 	 */
 	public httpTranslationsByIdFilterByProperty(
-		id: string,
-		property: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdFilterByPropertyRequestParams,
 		observe?: 'body',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<{ [key: string]: { [key: string]: object } }>;
 	public httpTranslationsByIdFilterByProperty(
-		id: string,
-		property: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdFilterByPropertyRequestParams,
 		observe?: 'response',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpResponse<{ [key: string]: { [key: string]: object } }>>;
 	public httpTranslationsByIdFilterByProperty(
-		id: string,
-		property: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdFilterByPropertyRequestParams,
 		observe?: 'events',
 		reportProgress?: boolean,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<HttpEvent<{ [key: string]: { [key: string]: object } }>>;
 	public httpTranslationsByIdFilterByProperty(
-		id: string,
-		property: string,
-		items?: boolean,
+		requestParameters?: HttpTranslationsByIdFilterByPropertyRequestParams,
 		observe: any = 'body',
 		reportProgress: boolean = false,
-		options?: { httpHeaderAccept?: 'application/json' }
+		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
 	): Observable<any> {
+		const id = requestParameters?.id;
 		if (id === null || id === undefined) {
 			throw new Error('Required parameter id was null or undefined when calling httpTranslationsByIdFilterByProperty.');
 		}
+		const property = requestParameters?.property;
 		if (property === null || property === undefined) {
 			throw new Error('Required parameter property was null or undefined when calling httpTranslationsByIdFilterByProperty.');
 		}
+		const items = requestParameters?.items;
 
-		let queryParameters = new HttpParams({ encoder: this.encoder });
+		let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
 		if (items !== undefined && items !== null) {
-			queryParameters = this.addToHttpParams(queryParameters, <any>items, 'items');
+			localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>items, 'items');
 		}
 
-		let headers = this.defaultHeaders;
+		let localVarHeaders = this.defaultHeaders;
 
-		let credential: string | undefined;
+		let localVarCredential: string | undefined;
 		// authentication (function_key) required
-		credential = this.configuration.lookupCredential('function_key');
-		if (credential) {
-			headers = headers.set('x-functions-key', credential);
+		localVarCredential = this.configuration.lookupCredential('function_key');
+		if (localVarCredential) {
+			localVarHeaders = localVarHeaders.set('x-functions-key', localVarCredential);
 		}
 
-		let httpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
-		if (httpHeaderAcceptSelected === undefined) {
+		let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
+		if (localVarHttpHeaderAcceptSelected === undefined) {
 			// to determine the Accept header
 			const httpHeaderAccepts: string[] = ['application/json'];
-			httpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+			localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
 		}
-		if (httpHeaderAcceptSelected !== undefined) {
-			headers = headers.set('Accept', httpHeaderAcceptSelected);
+		if (localVarHttpHeaderAcceptSelected !== undefined) {
+			localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
 		}
 
-		let responseType_: 'text' | 'json' = 'json';
-		if (httpHeaderAcceptSelected && httpHeaderAcceptSelected.startsWith('text')) {
-			responseType_ = 'text';
+		let localVarHttpContext: HttpContext | undefined = options && options.context;
+		if (localVarHttpContext === undefined) {
+			localVarHttpContext = new HttpContext();
 		}
 
-		return this.httpClient.get<{ [key: string]: { [key: string]: object } }>(
-			`${this.configuration.basePath}/translations/${encodeURIComponent(String(id))}/${encodeURIComponent(String(property))}`,
-			{
-				params: queryParameters,
-				responseType: <any>responseType_,
-				withCredentials: this.configuration.withCredentials,
-				headers: headers,
-				observe: observe,
-				reportProgress: reportProgress
+		let localVarTransferCache: boolean | undefined = options && options.transferCache;
+		if (localVarTransferCache === undefined) {
+			localVarTransferCache = true;
+		}
+
+		let responseType_: 'text' | 'json' | 'blob' = 'json';
+		if (localVarHttpHeaderAcceptSelected) {
+			if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+				responseType_ = 'text';
+			} else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+				responseType_ = 'json';
+			} else {
+				responseType_ = 'blob';
 			}
-		);
+		}
+
+		let localVarPath = `/translations/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/${this.configuration.encodeParam({ name: 'property', value: property, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`;
+		return this.httpClient.request<{ [key: string]: { [key: string]: object } }>('get', `${this.configuration.basePath}${localVarPath}`, {
+			context: localVarHttpContext,
+			params: localVarQueryParameters,
+			responseType: <any>responseType_,
+			withCredentials: this.configuration.withCredentials,
+			headers: localVarHeaders,
+			observe: observe,
+			transferCache: localVarTransferCache,
+			reportProgress: reportProgress
+		});
 	}
 }