@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
86 lines (85 loc) • 7.1 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { SideDefinition } from '../model/sideDefinition';
import { SideDefinitionRequest } from '../model/sideDefinitionRequest';
import { TransactionType } from '../model/transactionType';
import { TransactionTypeRequest } from '../model/transactionTypeRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class TransactionConfigurationService {
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;
/**
* [EXPERIMENTAL] DeleteTransactionType: Delete a transaction type
* /// 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 that the type is in
* @param type One of the type\'s aliases
* @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.
*/
deleteTransactionType(source: string, type: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>;
deleteTransactionType(source: string, type: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>;
deleteTransactionType(source: string, type: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetTransactionType: Get a single transaction configuration type
* Get a single transaction type. Returns failure if not found
* @param source The source that the type is in
* @param type One of the type\'s aliases
* @param asAt The asAt datetime at which to retrieve the transaction configuration. Defaults to returning the latest version of the transaction configuration type 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.
*/
getTransactionType(source: string, type: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<TransactionType>;
getTransactionType(source: string, type: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionType>>;
getTransactionType(source: string, type: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionType>>;
/**
* [EXPERIMENTAL] ListTransactionTypes: 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.
*/
listTransactionTypes(asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<{
[key: string]: Array<TransactionType>;
}>;
listTransactionTypes(asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<{
[key: string]: Array<TransactionType>;
}>>;
listTransactionTypes(asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<{
[key: string]: Array<TransactionType>;
}>>;
/**
* [EXPERIMENTAL] SetSideDefinition: Set a side definition
* Set a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.
* @param side The label to uniquely identify the side.
* @param sideDefinitionRequest The side definition to create or 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.
*/
setSideDefinition(side: string, sideDefinitionRequest: SideDefinitionRequest, observe?: 'body', reportProgress?: boolean): Observable<SideDefinition>;
setSideDefinition(side: string, sideDefinitionRequest: SideDefinitionRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SideDefinition>>;
setSideDefinition(side: string, sideDefinitionRequest: SideDefinitionRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SideDefinition>>;
/**
* [EXPERIMENTAL] SetTransactionType: Set a specific transaction type
* Set a transaction type for the given source and type. If the requested transaction type does not exist, it will be created 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 configuration for
* @param type One of the transaction configuration alias types to uniquely identify the configuration
* @param transactionTypeRequest The transaction configuration to set
* @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.
*/
setTransactionType(source: string, type: string, transactionTypeRequest: TransactionTypeRequest, observe?: 'body', reportProgress?: boolean): Observable<TransactionType>;
setTransactionType(source: string, type: string, transactionTypeRequest: TransactionTypeRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<TransactionType>>;
setTransactionType(source: string, type: string, transactionTypeRequest: TransactionTypeRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<TransactionType>>;
static ɵfac: i0.ɵɵFactoryDef<TransactionConfigurationService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<TransactionConfigurationService>;
}