UNPKG

@finbourne/lusid-sdk-angular16

Version:

An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API

337 lines (336 loc) 26.4 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CreateReconciliationRequest } from '../model/createReconciliationRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { InlineValuationsReconciliationRequest } from '../model/inlineValuationsReconciliationRequest'; import { ListAggregationReconciliation } from '../model/listAggregationReconciliation'; import { Mapping } from '../model/mapping'; import { PagedResourceListOfReconciliation } from '../model/pagedResourceListOfReconciliation'; import { PortfoliosReconciliationRequest } from '../model/portfoliosReconciliationRequest'; import { Reconciliation } from '../model/reconciliation'; import { ReconciliationRequest } from '../model/reconciliationRequest'; import { ReconciliationResponse } from '../model/reconciliationResponse'; import { ResourceListOfMapping } from '../model/resourceListOfMapping'; import { ResourceListOfReconciliationBreak } from '../model/resourceListOfReconciliationBreak'; import { TransactionReconciliationRequest } from '../model/transactionReconciliationRequest'; import { TransactionReconciliationRequestV2 } from '../model/transactionReconciliationRequestV2'; import { TransactionsReconciliationsResponse } from '../model/transactionsReconciliationsResponse'; import { UpdateReconciliationRequest } from '../model/updateReconciliationRequest'; import { ValuationsReconciliationRequest } from '../model/valuationsReconciliationRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class ReconciliationsService { 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] CreateScheduledReconciliation: Create a scheduled reconciliation * Create a scheduled reconciliation for the given request * @param scope The scope of the reconciliation * @param createReconciliationRequest The definition of the reconciliation * @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. */ createScheduledReconciliation(scope: string, createReconciliationRequest?: CreateReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Reconciliation>; createScheduledReconciliation(scope: string, createReconciliationRequest?: CreateReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Reconciliation>>; createScheduledReconciliation(scope: string, createReconciliationRequest?: CreateReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Reconciliation>>; /** * [EXPERIMENTAL] DeleteReconciliation: Delete scheduled reconciliation * Delete the given scheduled reconciliation * @param scope The scope of the scheduled reconciliation * @param code The code of the scheduled reconciliation * @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. */ deleteReconciliation(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DeletedEntityResponse>; deleteReconciliation(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteReconciliation(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EARLY ACCESS] DeleteReconciliationMapping: Delete a mapping * Deletes the mapping identified by the scope and code * @param scope The scope of the mapping. * @param code The code fof the mapping. * @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. */ deleteReconciliationMapping(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<string>; deleteReconciliationMapping(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<string>>; deleteReconciliationMapping(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<string>>; /** * [EXPERIMENTAL] GetReconciliation: Get scheduled reconciliation * Get the requested scheduled reconciliation * @param scope The scope of the scheduled reconciliation * @param code The code of the scheduled reconciliation * @param effectiveAt The effective datetime or cut label at which to retrieve the scheduled reconciliation. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the scheduled reconciliation. Defaults to returning the latest version of the reconciliation if not specified. * @param propertyKeys A list of property keys from the \&#39;Reconciliation\&#39; property domain to decorate onto the reconciliation. These must take the form {domain}/{scope}/{code}, for example \&#39;Reconciliation/Broker/Id\&#39;. * @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. */ getReconciliation(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Reconciliation>; getReconciliation(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Reconciliation>>; getReconciliation(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Reconciliation>>; /** * [EARLY ACCESS] GetReconciliationMapping: Get a mapping * Gets a mapping identified by the given scope and code * @param scope The scope of the mapping. * @param code The code of the mapping. * @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. */ getReconciliationMapping(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Mapping>; getReconciliationMapping(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Mapping>>; getReconciliationMapping(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Mapping>>; /** * [EARLY ACCESS] ListReconciliationMappings: List the reconciliation mappings * Lists all mappings this user is entitled to see * @param reconciliationType Optional parameter to specify which type of mappings should be returned. Defaults to Transaction if not provided. * @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. */ listReconciliationMappings(reconciliationType?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ResourceListOfMapping>; listReconciliationMappings(reconciliationType?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ResourceListOfMapping>>; listReconciliationMappings(reconciliationType?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ResourceListOfMapping>>; /** * [EXPERIMENTAL] ListReconciliations: List scheduled reconciliations * List all the scheduled reconciliations matching particular criteria * @param effectiveAt The effective datetime or cut label at which to list the TimeVariant properties for the reconciliation. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to list the reconciliation. Defaults to returning the latest version of each reconciliation if not specified. * @param page The pagination token to use to continue listing reconciliations; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. * @param limit When paginating, limit the results to this number. Defaults to 100 if not specified. * @param filter Expression to filter the results. For example, to filter on the reconciliation type, specify \&quot;id.Code eq \&#39;001\&#39;\&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. * @param propertyKeys A list of property keys from the \&#39;Reconciliation\&#39; domain to decorate onto each reconciliation. These must take the format {domain}/{scope}/{code}, for example \&#39;Reconciliation/Broker/Id\&#39;. * @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. */ listReconciliations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<PagedResourceListOfReconciliation>; listReconciliations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<PagedResourceListOfReconciliation>>; listReconciliations(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<PagedResourceListOfReconciliation>>; /** * ReconcileGeneric: Reconcile either holdings or valuations performed on one or two sets of holdings using one or two configuration recipes. The output is configurable for various types of comparisons, to allow tolerances on numerical and date-time data or case-insensitivity on strings, and elision of resulting differences where they are \&#39;empty\&#39; or null or zero. * Perform evaluation of one or two set of holdings (a portfolio of instruments) using one or two (potentially different) configuration recipes. Produce a breakdown of the resulting differences in evaluation that can be iterated through. * @param reconciliationRequest The specifications of the inputs to the reconciliation * @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. */ reconcileGeneric(reconciliationRequest?: ReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ReconciliationResponse>; reconcileGeneric(reconciliationRequest?: ReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ReconciliationResponse>>; reconcileGeneric(reconciliationRequest?: ReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ReconciliationResponse>>; /** * [EARLY ACCESS] ReconcileHoldings: Reconcile portfolio holdings * Reconcile the holdings of two portfolios. * @param sortBy Optional. Order the results by these fields. Use use the \&#39;-\&#39; 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 the left portfolio Code, use \&quot;left.portfolioId.code eq \&#39;string\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param portfoliosReconciliationRequest The specifications of the inputs to the reconciliation * @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. */ reconcileHoldings(sortBy?: Array<string>, limit?: number, filter?: string, portfoliosReconciliationRequest?: PortfoliosReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ResourceListOfReconciliationBreak>; reconcileHoldings(sortBy?: Array<string>, limit?: number, filter?: string, portfoliosReconciliationRequest?: PortfoliosReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ResourceListOfReconciliationBreak>>; reconcileHoldings(sortBy?: Array<string>, limit?: number, filter?: string, portfoliosReconciliationRequest?: PortfoliosReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ResourceListOfReconciliationBreak>>; /** * ReconcileInline: Reconcile valuations performed on one or two sets of inline instruments using one or two configuration recipes. * Perform valuation of one or two set of inline instruments using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. * @param inlineValuationsReconciliationRequest The specifications of the inputs to the reconciliation * @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. */ reconcileInline(inlineValuationsReconciliationRequest?: InlineValuationsReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ListAggregationReconciliation>; reconcileInline(inlineValuationsReconciliationRequest?: InlineValuationsReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ListAggregationReconciliation>>; reconcileInline(inlineValuationsReconciliationRequest?: InlineValuationsReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ListAggregationReconciliation>>; /** * [EARLY ACCESS] ReconcileTransactions: Perform a Transactions Reconciliation. * Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. * @param transactionReconciliationRequest * @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. */ reconcileTransactions(transactionReconciliationRequest?: TransactionReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<TransactionsReconciliationsResponse>; reconcileTransactions(transactionReconciliationRequest?: TransactionReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<TransactionsReconciliationsResponse>>; reconcileTransactions(transactionReconciliationRequest?: TransactionReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<TransactionsReconciliationsResponse>>; /** * [EXPERIMENTAL] ReconcileTransactionsV2: Perform a Transactions Reconciliation. * Evaluates two sets of transactions to determine which transactions from each set likely match using the rules of a specified mapping. * @param transactionReconciliationRequestV2 * @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. */ reconcileTransactionsV2(transactionReconciliationRequestV2?: TransactionReconciliationRequestV2, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ReconciliationResponse>; reconcileTransactionsV2(transactionReconciliationRequestV2?: TransactionReconciliationRequestV2, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ReconciliationResponse>>; reconcileTransactionsV2(transactionReconciliationRequestV2?: TransactionReconciliationRequestV2, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ReconciliationResponse>>; /** * ReconcileValuation: Reconcile valuations performed on one or two sets of holdings using one or two configuration recipes. * Perform valuation of one or two set of holdings using different one or two configuration recipes. Produce a breakdown of the resulting differences in valuation. * @param valuationsReconciliationRequest The specifications of the inputs to the reconciliation * @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. */ reconcileValuation(valuationsReconciliationRequest?: ValuationsReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ListAggregationReconciliation>; reconcileValuation(valuationsReconciliationRequest?: ValuationsReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ListAggregationReconciliation>>; reconcileValuation(valuationsReconciliationRequest?: ValuationsReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<ListAggregationReconciliation>>; /** * [EXPERIMENTAL] UpdateReconciliation: Update scheduled reconciliation * Update a given scheduled reconciliation * @param scope The scope of the reconciliation to be updated * @param code The code of the reconciliation to be updated * @param updateReconciliationRequest The updated definition of the reconciliation * @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. */ updateReconciliation(scope: string, code: string, updateReconciliationRequest?: UpdateReconciliationRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Reconciliation>; updateReconciliation(scope: string, code: string, updateReconciliationRequest?: UpdateReconciliationRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Reconciliation>>; updateReconciliation(scope: string, code: string, updateReconciliationRequest?: UpdateReconciliationRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Reconciliation>>; /** * [EARLY ACCESS] UpsertReconciliationMapping: Create or update a mapping * If no mapping exists with the specified scope and code will create a new one. Else will update the existing mapping * @param mapping The mapping to be created / updated. * @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. */ upsertReconciliationMapping(mapping?: Mapping, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Mapping>; upsertReconciliationMapping(mapping?: Mapping, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Mapping>>; upsertReconciliationMapping(mapping?: Mapping, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Mapping>>; static ɵfac: i0.ɵɵFactoryDeclaration<ReconciliationsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<ReconciliationsService>; }