Learn more  » Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Bower components Debian packages RPM packages NuGet packages

vipera-npm-registry / @wa-motif-open-api/configuration-service   js

Repository URL to install this package:

Version: 0.6.0 

/ lib / api / settings.service.d.ts

/**
 * Motif Configuration Service API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.0.0
 * Contact: info@vipera.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { Service } from '../model/service';
import { SettingCreate } from '../model/settingCreate';
import { SettingEntity } from '../model/settingEntity';
import { SettingUpdate } from '../model/settingUpdate';
import { Configuration } from '../configuration';
import { SettingsServiceInterface } from './settings.serviceInterface';
export declare class SettingsService implements SettingsServiceInterface {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
    /**
     * @param consumes string[] mime-types
     * @return true: consumes contains 'multipart/form-data', false: otherwise
     */
    private canConsumeForm;
    /**
     * Creates Configuration Setting
     * Creates Configuration Setting
     * @param service
     * @param settingCreate
     * @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.
     */
    createSetting(service: string, settingCreate?: SettingCreate, observe?: 'body', reportProgress?: boolean): Observable<SettingEntity>;
    createSetting(service: string, settingCreate?: SettingCreate, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SettingEntity>>;
    createSetting(service: string, settingCreate?: SettingCreate, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SettingEntity>>;
    /**
     * Deletes a current property for a service
     * Deletes a current property for a service
     * @param service
     * @param setting
     * @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.
     */
    deleteSetting(service: string, setting: string, observe?: 'body', reportProgress?: boolean): Observable<object>;
    deleteSetting(service: string, setting: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<object>>;
    deleteSetting(service: string, setting: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<object>>;
    /**
     * Deletes all current properties for a service.
     * Deletes all current properties for a service.
     * @param service
     * @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.
     */
    deleteSettings(service: string, observe?: 'body', reportProgress?: boolean): Observable<object>;
    deleteSettings(service: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<object>>;
    deleteSettings(service: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<object>>;
    /**
     * Retrieves Configurable Services
     * Retrieves Configurable Services
     * @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.
     */
    getServices(observe?: 'body', reportProgress?: boolean): Observable<Array<Service>>;
    getServices(observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Array<Service>>>;
    getServices(observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Array<Service>>>;
    /**
     * Retrieves Configuration Setting
     * Retrieves Configuration Setting
     * @param service
     * @param setting
     * @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.
     */
    getSetting(service: string, setting: string, observe?: 'body', reportProgress?: boolean): Observable<SettingEntity>;
    getSetting(service: string, setting: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SettingEntity>>;
    getSetting(service: string, setting: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SettingEntity>>;
    /**
     * Retrieves Configuration Settings
     * Retrieves Configuration Settings
     * @param service
     * @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.
     */
    getSettings(service: string, observe?: 'body', reportProgress?: boolean): Observable<Array<SettingEntity>>;
    getSettings(service: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Array<SettingEntity>>>;
    getSettings(service: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Array<SettingEntity>>>;
    /**
     * Updates Configuration Setting
     * Updates Configuration Setting
     * @param service
     * @param setting
     * @param settingUpdate
     * @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.
     */
    updateSetting(service: string, setting: string, settingUpdate?: SettingUpdate, observe?: 'body', reportProgress?: boolean): Observable<object>;
    updateSetting(service: string, setting: string, settingUpdate?: SettingUpdate, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<object>>;
    updateSetting(service: string, setting: string, settingUpdate?: SettingUpdate, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<object>>;
}