UNPKG

@agravity/private

Version:

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

606 lines (547 loc) 25.7 kB
/** * Agravity OpenAPI Documentation - Private Functions * * Contact: office@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 { SharedCollection } from '../model/sharedCollection.agravity'; // @ts-ignore import { SharedCollectionFull } from '../model/sharedCollectionFull.agravity'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS } from '../variables'; import { AgravityConfiguration } from '../configuration'; export interface HttpSharedCollectionsCreateRequestParams { /** This creates / adds an unique shared collection ID and adds the information to the collection (in DB). */ sharedCollection: SharedCollection; } export interface HttpSharedCollectionsDeleteByIdRequestParams { /** The ID of the shared collection. */ id: string; } export interface HttpSharedCollectionsGetRequestParams { /** Filter all shared collections with given ID. */ collectionid?: string; } export interface HttpSharedCollectionsGetByIdRequestParams { /** The ID of the shared collection. */ id: string; /** Each result returns the continous token if more results are available than requested. With this token, the next page could be fetched. (URL encoded!) */ continuationToken?: string; /** This number limits the page result of assets. */ limit?: number; /** How the return assets are sorted. Default is property: created_date (newest first). */ orderby?: string; /** The requested language of the response. If not matching it falls back to default language. */ acceptLanguage?: string; } export interface HttpSharedCollectionsUpdateByIdRequestParams { /** The ID of the shared collection. */ id: string; /** This updated shared collection to put in DB. */ sharedCollection: SharedCollection; } @Injectable({ providedIn: 'root' }) export class CollectionShareManagementService { protected basePath = 'http://localhost:7071/api'; public defaultHeaders = new HttpHeaders(); public configuration = new AgravityConfiguration(); public encoder: HttpParameterCodec; constructor( protected httpClient: HttpClient, @Optional() @Inject(BASE_PATH) basePath: string | string[], @Optional() configuration: AgravityConfiguration ) { 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; } this.configuration.basePath = basePath; } 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); } else { httpParams = this.addToHttpParamsRecursive(httpParams, value, key); } return httpParams; } private addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams { if (value == null) { return httpParams; } if (typeof value === 'object') { if (Array.isArray(value)) { (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().substring(0, 10)); } else { throw Error('key may not be null if value is Date'); } } else { Object.keys(value).forEach((k) => (httpParams = this.addToHttpParamsRecursive(httpParams, value[k], key != null ? `${key}.${k}` : k))); } } else if (key != null) { httpParams = httpParams.append(key, value); } else { throw Error('key may not be null if value is not object or array'); } return httpParams; } /** * Creates an additional shared collection * @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 httpSharedCollectionsCreate( requestParameters?: HttpSharedCollectionsCreateRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<SharedCollection>; public httpSharedCollectionsCreate( requestParameters?: HttpSharedCollectionsCreateRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpResponse<SharedCollection>>; public httpSharedCollectionsCreate( requestParameters?: HttpSharedCollectionsCreateRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpEvent<SharedCollection>>; public httpSharedCollectionsCreate( requestParameters?: HttpSharedCollectionsCreateRequestParams, observe: any = 'body', reportProgress: boolean = false, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<any> { const sharedCollection = requestParameters?.sharedCollection; if (sharedCollection === null || sharedCollection === undefined) { throw new Error('Required parameter sharedCollection was null or undefined when calling httpSharedCollectionsCreate.'); } let localVarHeaders = this.defaultHeaders; let localVarCredential: string | undefined; // authentication (msal_auth) required localVarCredential = this.configuration.lookupCredential('msal_auth'); if (localVarCredential) { localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential); } let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = ['application/json']; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } if (localVarHttpHeaderAcceptSelected !== undefined) { localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); } let localVarHttpContext: HttpContext | undefined = options && options.context; if (localVarHttpContext === undefined) { localVarHttpContext = new HttpContext(); } let localVarTransferCache: boolean | undefined = options && options.transferCache; if (localVarTransferCache === undefined) { localVarTransferCache = true; } // to determine the Content-Type header const consumes: string[] = ['application/json']; const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); if (httpContentTypeSelected !== undefined) { localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); } 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 = `/shared`; return this.httpClient.request<SharedCollection>('post', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, body: sharedCollection, responseType: <any>responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, observe: observe, transferCache: localVarTransferCache, reportProgress: reportProgress }); } /** * Deletes the shared collection with the given ID. * @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 httpSharedCollectionsDeleteById( requestParameters?: HttpSharedCollectionsDeleteByIdRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<any>; public httpSharedCollectionsDeleteById( requestParameters?: HttpSharedCollectionsDeleteByIdRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpResponse<any>>; public httpSharedCollectionsDeleteById( requestParameters?: HttpSharedCollectionsDeleteByIdRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpEvent<any>>; public httpSharedCollectionsDeleteById( requestParameters?: HttpSharedCollectionsDeleteByIdRequestParams, 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 httpSharedCollectionsDeleteById.'); } let localVarHeaders = this.defaultHeaders; let localVarCredential: string | undefined; // authentication (msal_auth) required localVarCredential = this.configuration.lookupCredential('msal_auth'); if (localVarCredential) { localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential); } let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = ['application/json']; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } if (localVarHttpHeaderAcceptSelected !== undefined) { localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); } let localVarHttpContext: HttpContext | undefined = options && options.context; if (localVarHttpContext === undefined) { localVarHttpContext = new HttpContext(); } 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 = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`; return this.httpClient.request<any>('delete', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, responseType: <any>responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, observe: observe, transferCache: localVarTransferCache, reportProgress: reportProgress }); } /** * This lists all the shared collections which are stored in the database for a specific user. * @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 httpSharedCollectionsGet( requestParameters?: HttpSharedCollectionsGetRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<Array<SharedCollection>>; public httpSharedCollectionsGet( requestParameters?: HttpSharedCollectionsGetRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpResponse<Array<SharedCollection>>>; public httpSharedCollectionsGet( requestParameters?: HttpSharedCollectionsGetRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpEvent<Array<SharedCollection>>>; public httpSharedCollectionsGet( requestParameters?: HttpSharedCollectionsGetRequestParams, observe: any = 'body', reportProgress: boolean = false, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<any> { const collectionid = requestParameters?.collectionid; let localVarQueryParameters = new HttpParams({ encoder: this.encoder }); if (collectionid !== undefined && collectionid !== null) { localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>collectionid, 'collectionid'); } let localVarHeaders = this.defaultHeaders; let localVarCredential: string | undefined; // authentication (msal_auth) required localVarCredential = this.configuration.lookupCredential('msal_auth'); if (localVarCredential) { localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential); } let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = ['application/json']; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } if (localVarHttpHeaderAcceptSelected !== undefined) { localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); } let localVarHttpContext: HttpContext | undefined = options && options.context; if (localVarHttpContext === undefined) { localVarHttpContext = new HttpContext(); } 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 = `/shared`; return this.httpClient.request<Array<SharedCollection>>('get', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, params: localVarQueryParameters, responseType: <any>responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, observe: observe, transferCache: localVarTransferCache, reportProgress: reportProgress }); } /** * Returns one single shared collection (from ID) * @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 httpSharedCollectionsGetById( requestParameters?: HttpSharedCollectionsGetByIdRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<SharedCollectionFull>; public httpSharedCollectionsGetById( requestParameters?: HttpSharedCollectionsGetByIdRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpResponse<SharedCollectionFull>>; public httpSharedCollectionsGetById( requestParameters?: HttpSharedCollectionsGetByIdRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpEvent<SharedCollectionFull>>; public httpSharedCollectionsGetById( requestParameters?: HttpSharedCollectionsGetByIdRequestParams, 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 httpSharedCollectionsGetById.'); } const continuationToken = requestParameters?.continuationToken; const limit = requestParameters?.limit; const orderby = requestParameters?.orderby; const acceptLanguage = requestParameters?.acceptLanguage; let localVarQueryParameters = new HttpParams({ encoder: this.encoder }); if (continuationToken !== undefined && continuationToken !== null) { localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>continuationToken, 'continuation_token'); } if (limit !== undefined && limit !== null) { localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>limit, 'limit'); } if (orderby !== undefined && orderby !== null) { localVarQueryParameters = this.addToHttpParams(localVarQueryParameters, <any>orderby, 'orderby'); } let localVarHeaders = this.defaultHeaders; if (acceptLanguage !== undefined && acceptLanguage !== null) { localVarHeaders = localVarHeaders.set('Accept-Language', String(acceptLanguage)); } let localVarCredential: string | undefined; // authentication (msal_auth) required localVarCredential = this.configuration.lookupCredential('msal_auth'); if (localVarCredential) { localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential); } let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = ['application/json']; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } if (localVarHttpHeaderAcceptSelected !== undefined) { localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); } let localVarHttpContext: HttpContext | undefined = options && options.context; if (localVarHttpContext === undefined) { localVarHttpContext = new HttpContext(); } 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 = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`; return this.httpClient.request<SharedCollectionFull>('get', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, params: localVarQueryParameters, responseType: <any>responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, observe: observe, transferCache: localVarTransferCache, reportProgress: reportProgress }); } /** * Updates an existing shared collection. * @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 httpSharedCollectionsUpdateById( requestParameters?: HttpSharedCollectionsUpdateByIdRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<SharedCollection>; public httpSharedCollectionsUpdateById( requestParameters?: HttpSharedCollectionsUpdateByIdRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpResponse<SharedCollection>>; public httpSharedCollectionsUpdateById( requestParameters?: HttpSharedCollectionsUpdateByIdRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; transferCache?: boolean } ): Observable<HttpEvent<SharedCollection>>; public httpSharedCollectionsUpdateById( requestParameters?: HttpSharedCollectionsUpdateByIdRequestParams, 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 httpSharedCollectionsUpdateById.'); } const sharedCollection = requestParameters?.sharedCollection; if (sharedCollection === null || sharedCollection === undefined) { throw new Error('Required parameter sharedCollection was null or undefined when calling httpSharedCollectionsUpdateById.'); } let localVarHeaders = this.defaultHeaders; let localVarCredential: string | undefined; // authentication (msal_auth) required localVarCredential = this.configuration.lookupCredential('msal_auth'); if (localVarCredential) { localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential); } let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = ['application/json']; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } if (localVarHttpHeaderAcceptSelected !== undefined) { localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); } let localVarHttpContext: HttpContext | undefined = options && options.context; if (localVarHttpContext === undefined) { localVarHttpContext = new HttpContext(); } let localVarTransferCache: boolean | undefined = options && options.transferCache; if (localVarTransferCache === undefined) { localVarTransferCache = true; } // to determine the Content-Type header const consumes: string[] = ['application/json']; const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); if (httpContentTypeSelected !== undefined) { localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); } 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 = `/shared/${this.configuration.encodeParam({ name: 'id', value: id, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}`; return this.httpClient.request<SharedCollection>('post', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, body: sharedCollection, responseType: <any>responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, observe: observe, transferCache: localVarTransferCache, reportProgress: reportProgress }); } }