@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
122 lines (121 loc) • 8.58 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateCutLabelDefinitionRequest } from '../model/createCutLabelDefinitionRequest';
import { CutLabelDefinition } from '../model/cutLabelDefinition';
import { PagedResourceListOfCutLabelDefinition } from '../model/pagedResourceListOfCutLabelDefinition';
import { UpdateCutLabelDefinitionRequest } from '../model/updateCutLabelDefinitionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class CutLabelDefinitionsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* CreateCutLabelDefinition: Create a Cut Label
* Create a Cut Label valid in all scopes
* @param createCutLabelDefinitionRequest The cut label 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.
*/
createCutLabelDefinition(createCutLabelDefinitionRequest?: CreateCutLabelDefinitionRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CutLabelDefinition>;
createCutLabelDefinition(createCutLabelDefinitionRequest?: CreateCutLabelDefinitionRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CutLabelDefinition>>;
createCutLabelDefinition(createCutLabelDefinitionRequest?: CreateCutLabelDefinitionRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CutLabelDefinition>>;
/**
* DeleteCutLabelDefinition: Delete a Cut Label
* Delete a specified cut label
* @param code The Code of the Cut Label that is being 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.
*/
deleteCutLabelDefinition(code: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<string>;
deleteCutLabelDefinition(code: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<string>>;
deleteCutLabelDefinition(code: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<string>>;
/**
* GetCutLabelDefinition: Get a Cut Label
* Get a specified cut label at a given time
* @param code The Code of the Cut Label that is being queried
* @param asAt The time at which to get the Cut Label
* @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.
*/
getCutLabelDefinition(code: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CutLabelDefinition>;
getCutLabelDefinition(code: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CutLabelDefinition>>;
getCutLabelDefinition(code: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CutLabelDefinition>>;
/**
* ListCutLabelDefinitions: List Existing Cut Labels
* List all the Cut Label Definitions that are valid at the given AsAt time
* @param asAt Optional. The As At time at which listed Cut Labels are valid
* @param sortBy Optional. Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName
* @param limit Optional. When paginating, limit the number of returned results to this many.
* @param filter Optional. Expression to filter the result set. For example, to filter on code, use \"code eq \'string\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param page The pagination token to use to continue listing cut labels from a previous call This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request.
* @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.
*/
listCutLabelDefinitions(asAt?: string, sortBy?: Array<string>, limit?: number, filter?: string, page?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfCutLabelDefinition>;
listCutLabelDefinitions(asAt?: string, sortBy?: Array<string>, limit?: number, filter?: string, page?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfCutLabelDefinition>>;
listCutLabelDefinitions(asAt?: string, sortBy?: Array<string>, limit?: number, filter?: string, page?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfCutLabelDefinition>>;
/**
* UpdateCutLabelDefinition: Update a Cut Label
* Update a specified cut label
* @param code The Code of the Cut Label that is being updated
* @param updateCutLabelDefinitionRequest The cut label update 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.
*/
updateCutLabelDefinition(code: string, updateCutLabelDefinitionRequest?: UpdateCutLabelDefinitionRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CutLabelDefinition>;
updateCutLabelDefinition(code: string, updateCutLabelDefinitionRequest?: UpdateCutLabelDefinitionRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CutLabelDefinition>>;
updateCutLabelDefinition(code: string, updateCutLabelDefinitionRequest?: UpdateCutLabelDefinitionRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CutLabelDefinition>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CutLabelDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CutLabelDefinitionsService>;
}