@finbourne/lusid-sdk-angular8/lib/generated/api/systemConfiguration.service.d.ts

An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { SetTransactionConfigurationSourceRequest } from '../model/setTransactionConfigurationSourceRequest';
import { SideConfigurationDataRequest } from '../model/sideConfigurationDataRequest';
import { TransactionConfigurationDataRequest } from '../model/transactionConfigurationDataRequest';
import { TransactionSetConfigurationData } from '../model/transactionSetConfigurationData';
import { TransactionSetConfigurationDataRequest } from '../model/transactionSetConfigurationDataRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class SystemConfigurationService {
    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;
    /**
     * [EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type
     * Create a new transaction type by specifying a definition and mappings to movements.
     * @param transactionConfigurationDataRequest A transaction type definition.
     * @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.
     */
    createConfigurationTransactionType(transactionConfigurationDataRequest?: TransactionConfigurationDataRequest, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    createConfigurationTransactionType(transactionConfigurationDataRequest?: TransactionConfigurationDataRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    createConfigurationTransactionType(transactionConfigurationDataRequest?: TransactionConfigurationDataRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    /**
     * [EXPERIMENTAL] CreateSideDefinition: Create side definition
     * Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.
     * @param sideConfigurationDataRequest The definition of the side.
     * @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.
     */
    createSideDefinition(sideConfigurationDataRequest?: SideConfigurationDataRequest, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    createSideDefinition(sideConfigurationDataRequest?: SideConfigurationDataRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    createSideDefinition(sideConfigurationDataRequest?: SideConfigurationDataRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    /**
     * [EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source
     * /// WARNING! Changing existing transaction types has a material impact on how data, new and old,  is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.
     * @param source The source to delete transaction configurations for
     * @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.
     */
    deleteTransactionConfigurationSource(source: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
    deleteTransactionConfigurationSource(source: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
    deleteTransactionConfigurationSource(source: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
    /**
     * [EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source
     * Returns failure if requested source is not found
     * @param source The source for which to retrieve transaction configurations
     * @param asAt The asAt datetime at which to retrieve the transaction configurations.              Defaults to returning the latest version of the transaction configurations if not specified.
     * @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.
     */
    getTransactionConfigurationSource(source: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    getTransactionConfigurationSource(source: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    getTransactionConfigurationSource(source: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    /**
     * [EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types
     * Get the list of current transaction types. For information on the default transaction types provided with  LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.
     * @param asAt The asAt datetime at which to retrieve the transaction types. Defaults              to returning the latest versions if not specified.
     * @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.
     */
    listConfigurationTransactionTypes(asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    listConfigurationTransactionTypes(asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    listConfigurationTransactionTypes(asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    /**
     * [EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types
     * Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own.                WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.
     * @param transactionSetConfigurationDataRequest The complete set of transaction type definitions.
     * @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.
     */
    setConfigurationTransactionTypes(transactionSetConfigurationDataRequest?: TransactionSetConfigurationDataRequest, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    setConfigurationTransactionTypes(transactionSetConfigurationDataRequest?: TransactionSetConfigurationDataRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    setConfigurationTransactionTypes(transactionSetConfigurationDataRequest?: TransactionSetConfigurationDataRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    /**
     * [EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source
     * This will replace all the existing transaction configurations for the given source                WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.
     * @param source The source to set the transaction configurations for
     * @param setTransactionConfigurationSourceRequest The set of transaction configurations
     * @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.
     */
    setTransactionConfigurationSource(source: string, setTransactionConfigurationSourceRequest: Array<SetTransactionConfigurationSourceRequest>, observe?: 'body', reportProgress?: boolean): Observable<TransactionSetConfigurationData>;
    setTransactionConfigurationSource(source: string, setTransactionConfigurationSourceRequest: Array<SetTransactionConfigurationSourceRequest>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionSetConfigurationData>>;
    setTransactionConfigurationSource(source: string, setTransactionConfigurationSourceRequest: Array<SetTransactionConfigurationSourceRequest>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionSetConfigurationData>>;
    static ɵfac: i0.ɵɵFactoryDef<SystemConfigurationService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDef<SystemConfigurationService>;
}