UNPKG

@finbourne/lusid-sdk-angular18

Version:

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

135 lines (134 loc) 8.63 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { ConfigurationRecipe } from '../model/configurationRecipe'; import { CreateRecipeRequest } from '../model/createRecipeRequest'; import { InlineValuationRequest } from '../model/inlineValuationRequest'; import { ListAggregationResponse } from '../model/listAggregationResponse'; import { ResourceListOfAggregationQuery } from '../model/resourceListOfAggregationQuery'; import { ValuationRequest } from '../model/valuationRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export interface GenerateConfigurationRecipeRequestParams { /** The scope of the portfolio */ scope: string; /** The code of the portfolio */ code: string; /** The request specifying the parameters to generating the recipe */ createRecipeRequest?: CreateRecipeRequest; } export interface GetQueryableKeysRequestParams { /** The pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call. */ page?: string; /** When paginating, limit the number of returned results to this many. */ limit?: number; /** Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */ filter?: string; } export interface GetValuationRequestParams { /** The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics */ valuationRequest?: ValuationRequest; } export interface GetValuationOfWeightedInstrumentsRequestParams { /** The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics */ inlineValuationRequest?: InlineValuationRequest; } export declare class AggregationService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. * Given a set of scopes, a portfolio Id and a basic recipe, this endpoint generates a configuration recipe with relevant rules that can value the instruments in the 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. */ generateConfigurationRecipe(requestParameters?: GenerateConfigurationRecipeRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ConfigurationRecipe>; generateConfigurationRecipe(requestParameters?: GenerateConfigurationRecipeRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ConfigurationRecipe>>; generateConfigurationRecipe(requestParameters?: GenerateConfigurationRecipeRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ConfigurationRecipe>>; /** * GetQueryableKeys: Query the set of supported \&quot;addresses\&quot; that can be queried from the aggregation endpoint. * When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return. * @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. */ getQueryableKeys(requestParameters?: GetQueryableKeysRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ResourceListOfAggregationQuery>; getQueryableKeys(requestParameters?: GetQueryableKeysRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ResourceListOfAggregationQuery>>; getQueryableKeys(requestParameters?: GetQueryableKeysRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ResourceListOfAggregationQuery>>; /** * GetValuation: Perform valuation for a list of portfolios and/or portfolio groups * Perform valuation on specified list of portfolio and/or portfolio groups for a set of dates. * @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. */ getValuation(requestParameters?: GetValuationRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ListAggregationResponse>; getValuation(requestParameters?: GetValuationRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ListAggregationResponse>>; getValuation(requestParameters?: GetValuationRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ListAggregationResponse>>; /** * GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio * Perform valuation on the portfolio that is defined by the weighted set of instruments passed to the request. * @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. */ getValuationOfWeightedInstruments(requestParameters?: GetValuationOfWeightedInstrumentsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<ListAggregationResponse>; getValuationOfWeightedInstruments(requestParameters?: GetValuationOfWeightedInstrumentsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<ListAggregationResponse>>; getValuationOfWeightedInstruments(requestParameters?: GetValuationOfWeightedInstrumentsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<ListAggregationResponse>>; static ɵfac: i0.ɵɵFactoryDeclaration<AggregationService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<AggregationService>; }