@agravity/private/api/structureImport.agravity.ts

The Agravity GlobalDAM API which allowes authenticated user to access the Agravity GlobalDAM Backend

/**
 * Agravity OpenAPI Documentation - Private Functions
 *
 * Contact: support@agravity.io
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/* tslint:disable:no-unused-variable member-ordering */

import { Inject, Injectable, Optional } from '@angular/core';
import { HttpClient, HttpHeaders, HttpParams, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { CustomHttpParameterCodec } from '../encoder';
import { Observable } from 'rxjs';

// @ts-ignore
import { AgravityErrorResponse } from '../model/agravityErrorResponse.agravity';
// @ts-ignore
import { BlobInfoObj } from '../model/blobInfoObj.agravity';

// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS } from '../variables';
import { AgravityConfiguration } from '../configuration';
import { BaseService } from '../api.base.service';

export interface HttpStructureCreateCollectionsRequestParams {
	/** The collection-type id to be used for creating the structure. If not given, the default collection-type is used (as defined in app settings). */
	collectiontypeid?: string;
	/** The collection id to be used as parent for creating the structure. If not given, the structure is created at root level of the given collection-type. */
	parent?: string;
	/** If set to true, the root folder level is treated as collection-type and not as collection. Cannot be used together with parameter \"parent\" or \"collectiontypeid\". Default is false. */
	rootiscolltype?: string;
}

@Injectable({
	providedIn: 'root'
})
export class StructureImportService extends BaseService {
	constructor(
		protected httpClient: HttpClient,
		@Optional() @Inject(BASE_PATH) basePath: string | string[],
		@Optional() configuration?: AgravityConfiguration
	) {
		super(basePath, configuration);
	}

	/**
	 * This endpoint reads and creates structure elements for subfolders in the database based on container folder structure
	 * @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 httpStructureCreateCollections(
		requestParameters?: HttpStructureCreateCollectionsRequestParams,
		observe?: 'body',
		reportProgress?: boolean,
		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
	): Observable<Array<BlobInfoObj>>;
	public httpStructureCreateCollections(
		requestParameters?: HttpStructureCreateCollectionsRequestParams,
		observe?: 'response',
		reportProgress?: boolean,
		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
	): Observable<HttpResponse<Array<BlobInfoObj>>>;
	public httpStructureCreateCollections(
		requestParameters?: HttpStructureCreateCollectionsRequestParams,
		observe?: 'events',
		reportProgress?: boolean,
		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
	): Observable<HttpEvent<Array<BlobInfoObj>>>;
	public httpStructureCreateCollections(
		requestParameters?: HttpStructureCreateCollectionsRequestParams,
		observe: any = 'body',
		reportProgress: boolean = false,
		options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean }
	): Observable<any> {
		const collectiontypeid = requestParameters?.collectiontypeid;
		const parent = requestParameters?.parent;
		const rootiscolltype = requestParameters?.rootiscolltype;

		let localVarQueryParameters = new HttpParams({ encoder: this.encoder });
		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectiontypeid, 'collectiontypeid');
		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>parent, 'parent');
		localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>rootiscolltype, 'rootiscolltype');

		let localVarHeaders = this.defaultHeaders;

		// authentication (msal_auth) required
		localVarHeaders = this.configuration.addCredentialToHeaders('msal_auth', 'Authorization', localVarHeaders, 'Bearer ');

		const localVarHttpHeaderAcceptSelected: string | undefined = options?.httpHeaderAccept ?? this.configuration.selectHeaderAccept(['application/json']);
		if (localVarHttpHeaderAcceptSelected !== undefined) {
			localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
		}

		const localVarHttpContext: HttpContext = options?.context ?? new HttpContext();

		const localVarTransferCache: boolean = options?.transferCache ?? 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 = `/structure`;
		const { basePath, withCredentials } = this.configuration;
		return this.httpClient.request<Array<BlobInfoObj>>('put', `${basePath}${localVarPath}`, {
			context: localVarHttpContext,
			params: localVarQueryParameters,
			responseType: <any>responseType_,
			...(withCredentials ? { withCredentials } : {}),
			headers: localVarHeaders,
			observe: observe,
			transferCache: localVarTransferCache,
			reportProgress: reportProgress
		});
	}
}