@veeroute/lss-studio-angular/api/customFieldsService.d.ts

OpenAPI client for @veeroute/lss-studio-angular

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CustomfieldsSettingsStudio } from '../model/customfieldsSettings';
import { SettingsKeyListStudio } from '../model/settingsKeyList';
import { Configuration } from '../configuration';
import { CustomFieldsServiceInterface, CreateCustomfieldsSettingsRequestParams, DeleteCustomfieldsSettingsRequestParams, ReadCustomfieldsSettingsRequestParams, SetCustomfieldsSettingsActiveKeyRequestParams, UpdateCustomfieldsSettingsRequestParams } from './customFieldsServiceInterface';
import * as i0 from "@angular/core";
export declare class CustomFieldsService implements CustomFieldsServiceInterface {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    encoder: HttpParameterCodec;
    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
    private addToHttpParams;
    private addToHttpParamsRecursive;
    /**
     * Create fields settings
     * Create custom fields settings.
     * @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.
     */
    createCustomfieldsSettings(requestParameters: CreateCustomfieldsSettingsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CustomfieldsSettingsStudio>;
    createCustomfieldsSettings(requestParameters: CreateCustomfieldsSettingsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CustomfieldsSettingsStudio>>;
    createCustomfieldsSettings(requestParameters: CreateCustomfieldsSettingsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CustomfieldsSettingsStudio>>;
    /**
     * Delete fields settings
     * Delete custom fields settings.
     * @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.
     */
    deleteCustomfieldsSettings(requestParameters: DeleteCustomfieldsSettingsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<any>;
    deleteCustomfieldsSettings(requestParameters: DeleteCustomfieldsSettingsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<any>>;
    deleteCustomfieldsSettings(requestParameters: DeleteCustomfieldsSettingsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<any>>;
    /**
     * Reading fields settings list
     * Reading the list of custom field settings keys.
     * @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.
     */
    listCustomfieldsSettings(observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<SettingsKeyListStudio>;
    listCustomfieldsSettings(observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<SettingsKeyListStudio>>;
    listCustomfieldsSettings(observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<SettingsKeyListStudio>>;
    /**
     * Reading fields settings
     * Reading custom field settings.
     * @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.
     */
    readCustomfieldsSettings(requestParameters: ReadCustomfieldsSettingsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CustomfieldsSettingsStudio>;
    readCustomfieldsSettings(requestParameters: ReadCustomfieldsSettingsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CustomfieldsSettingsStudio>>;
    readCustomfieldsSettings(requestParameters: ReadCustomfieldsSettingsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CustomfieldsSettingsStudio>>;
    /**
     * Setting the active customfields key
     * Setting the active customfields 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.
     */
    setCustomfieldsSettingsActiveKey(requestParameters: SetCustomfieldsSettingsActiveKeyRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<SettingsKeyListStudio>;
    setCustomfieldsSettingsActiveKey(requestParameters: SetCustomfieldsSettingsActiveKeyRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<SettingsKeyListStudio>>;
    setCustomfieldsSettingsActiveKey(requestParameters: SetCustomfieldsSettingsActiveKeyRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<SettingsKeyListStudio>>;
    /**
     * Update fields settings
     * Update custom fields settings.
     * @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.
     */
    updateCustomfieldsSettings(requestParameters: UpdateCustomfieldsSettingsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<CustomfieldsSettingsStudio>;
    updateCustomfieldsSettings(requestParameters: UpdateCustomfieldsSettingsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<CustomfieldsSettingsStudio>>;
    updateCustomfieldsSettings(requestParameters: UpdateCustomfieldsSettingsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'application/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<CustomfieldsSettingsStudio>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<CustomFieldsService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<CustomFieldsService>;
}