@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
175 lines (174 loc) • 12.4 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { BucketedCashFlowResponse } from '../model/bucketedCashFlowResponse';
import { QueryApplicableInstrumentEventsRequest } from '../model/queryApplicableInstrumentEventsRequest';
import { QueryBucketedCashFlowsRequest } from '../model/queryBucketedCashFlowsRequest';
import { QueryCashFlowsRequest } from '../model/queryCashFlowsRequest';
import { QueryInstrumentEventsRequest } from '../model/queryInstrumentEventsRequest';
import { QueryTradeTicketsRequest } from '../model/queryTradeTicketsRequest';
import { ResourceListOfApplicableInstrumentEvent } from '../model/resourceListOfApplicableInstrumentEvent';
import { ResourceListOfInstrumentCashFlow } from '../model/resourceListOfInstrumentCashFlow';
import { ResourceListOfInstrumentEventHolder } from '../model/resourceListOfInstrumentEventHolder';
import { ResourceListOfPortfolioTradeTicket } from '../model/resourceListOfPortfolioTradeTicket';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface QueryApplicableInstrumentEventsRequestParams {
/** The as at time to use. */
asAt?: string;
/** Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used. */
limit?: number;
/** Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this */
page?: string;
/** The filter parameters used to retrieve applicable instrument events. */
queryApplicableInstrumentEventsRequest?: QueryApplicableInstrumentEventsRequest;
}
export interface QueryBucketedCashFlowsRequestParams {
/** The Query Information. */
queryBucketedCashFlowsRequest?: QueryBucketedCashFlowsRequest;
}
export interface QueryCashFlowsRequestParams {
/** Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. */
limit?: number;
/** Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified. */
page?: string;
/** The filter parameters used to retrieve instrument events. */
queryCashFlowsRequest?: QueryCashFlowsRequest;
}
export interface QueryInstrumentEventsRequestParams {
/** Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. */
limit?: number;
/** Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified. */
page?: string;
/** The filter parameters used to retrieve instrument events. */
queryInstrumentEventsRequest?: QueryInstrumentEventsRequest;
}
export interface QueryTradeTicketsRequestParams {
/** Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used. */
limit?: number;
/** Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified. */
page?: string;
/** The filter parameters used to retrieve instrument events. */
queryTradeTicketsRequest?: QueryTradeTicketsRequest;
}
export declare class InstrumentEventsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.
* Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query.
* @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.
*/
queryApplicableInstrumentEvents(requestParameters?: QueryApplicableInstrumentEventsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfApplicableInstrumentEvent>;
queryApplicableInstrumentEvents(requestParameters?: QueryApplicableInstrumentEventsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfApplicableInstrumentEvent>>;
queryApplicableInstrumentEvents(requestParameters?: QueryApplicableInstrumentEventsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfApplicableInstrumentEvent>>;
/**
* QueryBucketedCashFlows: Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.
* Returns bucketed cashflows based on the holdings of the portfolios and date range specified in the query.
* @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.
*/
queryBucketedCashFlows(requestParameters?: QueryBucketedCashFlowsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<BucketedCashFlowResponse>;
queryBucketedCashFlows(requestParameters?: QueryBucketedCashFlowsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<BucketedCashFlowResponse>>;
queryBucketedCashFlows(requestParameters?: QueryBucketedCashFlowsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<BucketedCashFlowResponse>>;
/**
* QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.
* Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query.
* @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.
*/
queryCashFlows(requestParameters?: QueryCashFlowsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfInstrumentCashFlow>;
queryCashFlows(requestParameters?: QueryCashFlowsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfInstrumentCashFlow>>;
queryCashFlows(requestParameters?: QueryCashFlowsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfInstrumentCashFlow>>;
/**
* QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
* Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
* @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.
*/
queryInstrumentEvents(requestParameters?: QueryInstrumentEventsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfInstrumentEventHolder>;
queryInstrumentEvents(requestParameters?: QueryInstrumentEventsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfInstrumentEventHolder>>;
queryInstrumentEvents(requestParameters?: QueryInstrumentEventsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfInstrumentEventHolder>>;
/**
* QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.
* Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration.
* @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.
*/
queryTradeTickets(requestParameters?: QueryTradeTicketsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfPortfolioTradeTicket>;
queryTradeTickets(requestParameters?: QueryTradeTicketsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfPortfolioTradeTicket>>;
queryTradeTickets(requestParameters?: QueryTradeTicketsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfPortfolioTradeTicket>>;
static ɵfac: i0.ɵɵFactoryDeclaration<InstrumentEventsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<InstrumentEventsService>;
}