@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
181 lines (180 loc) • 12.4 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateReferencePortfolioRequest } from '../model/createReferencePortfolioRequest';
import { GetReferencePortfolioConstituentsResponse } from '../model/getReferencePortfolioConstituentsResponse';
import { Portfolio } from '../model/portfolio';
import { ResourceListOfConstituentsAdjustmentHeader } from '../model/resourceListOfConstituentsAdjustmentHeader';
import { UpsertReferencePortfolioConstituentPropertiesRequest } from '../model/upsertReferencePortfolioConstituentPropertiesRequest';
import { UpsertReferencePortfolioConstituentPropertiesResponse } from '../model/upsertReferencePortfolioConstituentPropertiesResponse';
import { UpsertReferencePortfolioConstituentsRequest } from '../model/upsertReferencePortfolioConstituentsRequest';
import { UpsertReferencePortfolioConstituentsResponse } from '../model/upsertReferencePortfolioConstituentsResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateReferencePortfolioRequestParams {
/** The scope in which to create the reference portfolio. */
scope: string;
/** The definition of the reference portfolio. */
createReferencePortfolioRequest: CreateReferencePortfolioRequest;
}
export interface GetReferencePortfolioConstituentsRequestParams {
/** The scope of the reference portfolio. */
scope: string;
/** The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. */
code: string;
/** The effective date of the constituents to retrieve. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve constituents. Defaults to return the latest version of each constituent if not specified. */
asAt?: string;
/** A list of property keys from the \'Instrument\' or \'ReferenceHolding\' domain to decorate onto constituents. These take the format {domain}/{scope}/{code} e.g. \'Instrument/system/Name\' or \'ReferenceHolding/strategy/quantsignal\'. Defaults to return all available instrument and reference holding properties if not specified. */
propertyKeys?: Array<string>;
}
export interface ListConstituentsAdjustmentsRequestParams {
/** The scope of the reference portfolio. */
scope: string;
/** The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. */
code: string;
/** Events between this time (inclusive) and the toEffectiveAt are returned. */
fromEffectiveAt: string;
/** Events between this time (inclusive) and the fromEffectiveAt are returned. */
toEffectiveAt: string;
/** The asAt time for which the result is valid. */
asAtTime?: string;
}
export interface UpsertReferencePortfolioConstituentPropertiesRequestParams {
/** The scope of the reference portfolio. */
scope: string;
/** The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. */
code: string;
/** The request to modify properties for the constituent. */
upsertReferencePortfolioConstituentPropertiesRequest: UpsertReferencePortfolioConstituentPropertiesRequest;
}
export interface UpsertReferencePortfolioConstituentsRequestParams {
/** The scope of the reference portfolio. */
scope: string;
/** The code of the reference portfolio. Together with the scope this uniquely identifies the reference portfolio. */
code: string;
/** The constituents to upload to the reference portfolio. */
upsertReferencePortfolioConstituentsRequest: UpsertReferencePortfolioConstituentsRequest;
}
export declare class ReferencePortfolioService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* CreateReferencePortfolio: Create reference portfolio
* Create a reference portfolio in a particular scope.
* @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.
*/
createReferencePortfolio(requestParameters?: CreateReferencePortfolioRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Portfolio>;
createReferencePortfolio(requestParameters?: CreateReferencePortfolioRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Portfolio>>;
createReferencePortfolio(requestParameters?: CreateReferencePortfolioRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Portfolio>>;
/**
* GetReferencePortfolioConstituents: Get reference portfolio constituents
* Get constituents from a reference portfolio at a particular effective time.
* @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.
*/
getReferencePortfolioConstituents(requestParameters?: GetReferencePortfolioConstituentsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<GetReferencePortfolioConstituentsResponse>;
getReferencePortfolioConstituents(requestParameters?: GetReferencePortfolioConstituentsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<GetReferencePortfolioConstituentsResponse>>;
getReferencePortfolioConstituents(requestParameters?: GetReferencePortfolioConstituentsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<GetReferencePortfolioConstituentsResponse>>;
/**
* ListConstituentsAdjustments: List constituents adjustments
* List adjustments made to constituents in a reference portfolio.
* @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.
*/
listConstituentsAdjustments(requestParameters?: ListConstituentsAdjustmentsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfConstituentsAdjustmentHeader>;
listConstituentsAdjustments(requestParameters?: ListConstituentsAdjustmentsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfConstituentsAdjustmentHeader>>;
listConstituentsAdjustments(requestParameters?: ListConstituentsAdjustmentsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfConstituentsAdjustmentHeader>>;
/**
* [EARLY ACCESS] UpsertReferencePortfolioConstituentProperties: Upsert constituent properties
* Create or update one or more constituent properties for a single constituent in the reference portfolio. Each property will be updated if it already exists, created if it does not and deleted if value is null. Both constituent and portfolio must exist at the time when properties are created or updated.
* @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.
*/
upsertReferencePortfolioConstituentProperties(requestParameters?: UpsertReferencePortfolioConstituentPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<UpsertReferencePortfolioConstituentPropertiesResponse>;
upsertReferencePortfolioConstituentProperties(requestParameters?: UpsertReferencePortfolioConstituentPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<UpsertReferencePortfolioConstituentPropertiesResponse>>;
upsertReferencePortfolioConstituentProperties(requestParameters?: UpsertReferencePortfolioConstituentPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<UpsertReferencePortfolioConstituentPropertiesResponse>>;
/**
* UpsertReferencePortfolioConstituents: Upsert reference portfolio constituents
* Add constituents to a reference portfolio.
* @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.
*/
upsertReferencePortfolioConstituents(requestParameters?: UpsertReferencePortfolioConstituentsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<UpsertReferencePortfolioConstituentsResponse>;
upsertReferencePortfolioConstituents(requestParameters?: UpsertReferencePortfolioConstituentsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<UpsertReferencePortfolioConstituentsResponse>>;
upsertReferencePortfolioConstituents(requestParameters?: UpsertReferencePortfolioConstituentsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<UpsertReferencePortfolioConstituentsResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<ReferencePortfolioService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<ReferencePortfolioService>;
}