geonetwork-ui 2.1.0-initial → 2.2.0-dev.0f95f702

package/src/libs/data-access/gn4/src/openapi/api/tools.api.service.ts

@@ -1,8 +1,8 @@
 /**
- * GeoNetwork 4.0.3 OpenAPI Documentation
+ * GeoNetwork 4.2.7 OpenAPI Documentation
  * This is the description of the GeoNetwork OpenAPI. Use this API to manage your catalog.
  *
- * The version of the OpenAPI document: 4.0.3
+ * The version of the OpenAPI document: 4.2.7
  * Contact: geonetwork-users@lists.sourceforge.net
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,6 +23,8 @@ import {
 import { CustomHttpParameterCodec } from '../encoder'
 import { Observable } from 'rxjs'
 
+import { TranslationsApiModel } from '../model/models'
+
 import { BASE_PATH, COLLECTION_FORMATS } from '../variables'
 import { Configuration } from '../configuration'
 
@@ -30,7 +32,7 @@ import { Configuration } from '../configuration'
   providedIn: 'root',
 })
 export class ToolsApiService {
-  protected basePath = 'https://apps.titellus.net/geonetwork/srv/api'
+  protected basePath = 'https://demo.georchestra.org/geonetwork/srv/api'
   public defaultHeaders = new HttpHeaders()
   public configuration = new Configuration()
   public encoder: HttpParameterCodec
@@ -108,14 +110,109 @@ export class ToolsApiService {
   }
 
   /**
-   * Add or update database translations.
-   * @param key
-   * @param requestBody
+   * Add or update all database translations.
+   * @param translationsApiModel
    * @param replace
    * @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 addTranslations(
+    translationsApiModel: Array<TranslationsApiModel>,
+    replace?: boolean,
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<string>
+  public addTranslations(
+    translationsApiModel: Array<TranslationsApiModel>,
+    replace?: boolean,
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpResponse<string>>
+  public addTranslations(
+    translationsApiModel: Array<TranslationsApiModel>,
+    replace?: boolean,
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpEvent<string>>
+  public addTranslations(
+    translationsApiModel: Array<TranslationsApiModel>,
+    replace?: boolean,
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any> {
+    if (translationsApiModel === null || translationsApiModel === undefined) {
+      throw new Error(
+        'Required parameter translationsApiModel was null or undefined when calling addTranslations.'
+      )
+    }
+
+    let queryParameters = new HttpParams({ encoder: this.encoder })
+    if (replace !== undefined && replace !== null) {
+      queryParameters = this.addToHttpParams(
+        queryParameters,
+        <any>replace,
+        'replace'
+      )
+    }
+
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json']
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    // to determine the Content-Type header
+    const consumes: string[] = ['application/json']
+    const httpContentTypeSelected: string | undefined =
+      this.configuration.selectHeaderContentType(consumes)
+    if (httpContentTypeSelected !== undefined) {
+      headers = headers.set('Content-Type', httpContentTypeSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.put<string>(
+      `${this.configuration.basePath}/i18n/db/translations`,
+      translationsApiModel,
+      {
+        params: queryParameters,
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
+
+  /**
+   * Add or update database translations for a key.
+   * Database translations can be used to customize labels in the UI for different languages.
+   * @param key Untranslated key for which translations are provided.
+   * @param requestBody An object where keys are valid 3-letter language codes (e.g. &#x60;eng&#x60; or &#x60;fre&#x60;) and values are custom translations for the corresponding language.
+   * @param replace Set to &#x60;true&#x60; to erase all existing translations for that key
+   * @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 addTranslationsFor(
     key: string,
     requestBody: { [key: string]: string },
     replace?: boolean,
@@ -123,7 +220,7 @@ export class ToolsApiService {
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
   ): Observable<string>
-  public addTranslations(
+  public addTranslationsFor(
     key: string,
     requestBody: { [key: string]: string },
     replace?: boolean,
@@ -131,7 +228,7 @@ export class ToolsApiService {
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
   ): Observable<HttpResponse<string>>
-  public addTranslations(
+  public addTranslationsFor(
     key: string,
     requestBody: { [key: string]: string },
     replace?: boolean,
@@ -139,7 +236,7 @@ export class ToolsApiService {
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
   ): Observable<HttpEvent<string>>
-  public addTranslations(
+  public addTranslationsFor(
     key: string,
     requestBody: { [key: string]: string },
     replace?: boolean,
@@ -149,12 +246,12 @@ export class ToolsApiService {
   ): Observable<any> {
     if (key === null || key === undefined) {
       throw new Error(
-        'Required parameter key was null or undefined when calling addTranslations.'
+        'Required parameter key was null or undefined when calling addTranslationsFor.'
       )
     }
     if (requestBody === null || requestBody === undefined) {
       throw new Error(
-        'Required parameter requestBody was null or undefined when calling addTranslations.'
+        'Required parameter requestBody was null or undefined when calling addTranslationsFor.'
       )
     }
 
@@ -213,9 +310,94 @@ export class ToolsApiService {
     )
   }
 
+  /**
+   * Generate an OGC filter
+   * From a JSON filter, return an OGC filter expression.
+   * @param filters The filters in JSON
+   * @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 buildFilter(
+    filters: string,
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'application/xml' }
+  ): Observable<string>
+  public buildFilter(
+    filters: string,
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'application/xml' }
+  ): Observable<HttpResponse<string>>
+  public buildFilter(
+    filters: string,
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'application/xml' }
+  ): Observable<HttpEvent<string>>
+  public buildFilter(
+    filters: string,
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' | 'application/xml' }
+  ): Observable<any> {
+    if (filters === null || filters === undefined) {
+      throw new Error(
+        'Required parameter filters was null or undefined when calling buildFilter.'
+      )
+    }
+
+    let queryParameters = new HttpParams({ encoder: this.encoder })
+    if (filters !== undefined && filters !== null) {
+      queryParameters = this.addToHttpParams(
+        queryParameters,
+        <any>filters,
+        'filters'
+      )
+    }
+
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = [
+        'application/json',
+        'application/xml',
+      ]
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.post<string>(
+      `${this.configuration.basePath}/tools/ogc/filter`,
+      null,
+      {
+        params: queryParameters,
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
+
   /**
    * Generate a SLD with a new filter
-   * Get the currend SLD for the requested layers, add new filters in, save the SLD and return the new SLD URL.
+   * Get the current SLD for the requested layers, add new filters in, save the SLD and return the new SLD URL.
    * @param url The WMS server URL
    * @param layers The layers
    * @param filters The filters in JSON
@@ -459,7 +641,8 @@ export class ToolsApiService {
 
   /**
    * Delete database translations.
-   * @param key
+   * Delete custom translations stored in the database.
+   * @param key Untranslated key for which all translations will be deleted.
    * @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.
    */
@@ -589,6 +772,164 @@ export class ToolsApiService {
     )
   }
 
+  /**
+   * Download a SLD
+   * @param id The SLD identifier
+   * @param extension
+   * @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 downloadSLD(
+    id: number,
+    extension: string,
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any>
+  public downloadSLD(
+    id: number,
+    extension: string,
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpResponse<any>>
+  public downloadSLD(
+    id: number,
+    extension: string,
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpEvent<any>>
+  public downloadSLD(
+    id: number,
+    extension: string,
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any> {
+    if (id === null || id === undefined) {
+      throw new Error(
+        'Required parameter id was null or undefined when calling downloadSLD.'
+      )
+    }
+    if (extension === null || extension === undefined) {
+      throw new Error(
+        'Required parameter extension was null or undefined when calling downloadSLD.'
+      )
+    }
+
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json']
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.get<any>(
+      `${this.configuration.basePath}/tools/ogc/sld/${encodeURIComponent(
+        String(id)
+      )}.${encodeURIComponent(String(extension))}`,
+      {
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
+
+  /**
+   * List custom user translations
+   * @param type
+   * @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 getCustomTranslations(
+    type?: Array<string>,
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<Array<TranslationsApiModel>>
+  public getCustomTranslations(
+    type?: Array<string>,
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpResponse<Array<TranslationsApiModel>>>
+  public getCustomTranslations(
+    type?: Array<string>,
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpEvent<Array<TranslationsApiModel>>>
+  public getCustomTranslations(
+    type?: Array<string>,
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any> {
+    let queryParameters = new HttpParams({ encoder: this.encoder })
+    if (type) {
+      type.forEach((element) => {
+        queryParameters = this.addToHttpParams(
+          queryParameters,
+          <any>element,
+          'type'
+        )
+      })
+    }
+
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json']
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.get<Array<TranslationsApiModel>>(
+      `${this.configuration.basePath}/i18n/db/custom`,
+      {
+        params: queryParameters,
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
+
   /**
    * List database translations (used to overrides client application translations).
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -598,17 +939,17 @@ export class ToolsApiService {
     observe?: 'body',
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
-  ): Observable<{ [key: string]: string }>
+  ): Observable<Record<string, string>>
   public getDbTranslations(
     observe?: 'response',
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
-  ): Observable<HttpResponse<{ [key: string]: string }>>
+  ): Observable<HttpResponse<Record<string, string>>>
   public getDbTranslations(
     observe?: 'events',
     reportProgress?: boolean,
     options?: { httpHeaderAccept?: 'application/json' }
-  ): Observable<HttpEvent<{ [key: string]: string }>>
+  ): Observable<HttpEvent<Record<string, string>>>
   public getDbTranslations(
     observe: any = 'body',
     reportProgress: boolean = false,
@@ -636,7 +977,7 @@ export class ToolsApiService {
       responseType_ = 'text'
     }
 
-    return this.httpClient.get<{ [key: string]: string }>(
+    return this.httpClient.get<Record<string, string>>(
       `${this.configuration.basePath}/i18n/db/translations`,
       {
         responseType: <any>responseType_,
@@ -913,4 +1254,123 @@ export class ToolsApiService {
       }
     )
   }
+
+  /**
+   * Remove all database translations.
+   * @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 removeAllTranslations(
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any>
+  public removeAllTranslations(
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpResponse<any>>
+  public removeAllTranslations(
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<HttpEvent<any>>
+  public removeAllTranslations(
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' }
+  ): Observable<any> {
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json']
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.delete<any>(
+      `${this.configuration.basePath}/i18n/db/translations`,
+      {
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
+
+  /**
+   * Test mail configuration
+   * Send an email to the catalog feedback email.
+   * @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 testMailConfiguration(
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'text/plain' }
+  ): Observable<string>
+  public testMailConfiguration(
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'text/plain' }
+  ): Observable<HttpResponse<string>>
+  public testMailConfiguration(
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: { httpHeaderAccept?: 'application/json' | 'text/plain' }
+  ): Observable<HttpEvent<string>>
+  public testMailConfiguration(
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: { httpHeaderAccept?: 'application/json' | 'text/plain' }
+  ): Observable<any> {
+    let headers = this.defaultHeaders
+
+    let httpHeaderAcceptSelected: string | undefined =
+      options && options.httpHeaderAccept
+    if (httpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json', 'text/plain']
+      httpHeaderAcceptSelected =
+        this.configuration.selectHeaderAccept(httpHeaderAccepts)
+    }
+    if (httpHeaderAcceptSelected !== undefined) {
+      headers = headers.set('Accept', httpHeaderAcceptSelected)
+    }
+
+    let responseType_: 'text' | 'json' = 'json'
+    if (
+      httpHeaderAcceptSelected &&
+      httpHeaderAcceptSelected.startsWith('text')
+    ) {
+      responseType_ = 'text'
+    }
+
+    return this.httpClient.get<string>(
+      `${this.configuration.basePath}/tools/mail/test`,
+      {
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: headers,
+        observe: observe,
+        reportProgress: reportProgress,
+      }
+    )
+  }
 }