@finbourne/lusid-sdk-angular8

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AnnulStructuredDataResponse } from '../model/annulStructuredDataResponse'; import { CreateDataMapRequest } from '../model/createDataMapRequest'; import { DataMapKey } from '../model/dataMapKey'; import { GetDataMapResponse } from '../model/getDataMapResponse'; import { GetStructuredResultDataResponse } from '../model/getStructuredResultDataResponse'; import { GetVirtualDocumentResponse } from '../model/getVirtualDocumentResponse'; import { StructuredResultDataId } from '../model/structuredResultDataId'; import { UpsertResultValuesDataRequest } from '../model/upsertResultValuesDataRequest'; import { UpsertStructuredDataResponse } from '../model/upsertStructuredDataResponse'; import { UpsertStructuredResultDataRequest } from '../model/upsertStructuredResultDataRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class StructuredResultDataService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * [EXPERIMENTAL] CreateDataMap: Create data map * Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. * @param scope The scope in which to create or update data maps. * @param requestBody Individual data map creation requests. * @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. */ createDataMap(scope: string, requestBody: { [key: string]: CreateDataMapRequest; }, observe?: 'body', reportProgress?: boolean): Observable<UpsertStructuredDataResponse>; createDataMap(scope: string, requestBody: { [key: string]: CreateDataMapRequest; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertStructuredDataResponse>>; createDataMap(scope: string, requestBody: { [key: string]: CreateDataMapRequest; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertStructuredDataResponse>>; /** * [EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data * Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. * @param scope The scope from which to delete data items. * @param requestBody The data IDs to delete, each keyed by a unique, ephemeral correlation ID. * @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. */ deleteStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, observe?: 'body', reportProgress?: boolean): Observable<AnnulStructuredDataResponse>; deleteStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulStructuredDataResponse>>; deleteStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulStructuredDataResponse>>; /** * [EXPERIMENTAL] GetDataMap: Get data map * Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. * @param scope The scope from which to retrieve data maps. * @param requestBody The data map keys to look up, each keyed by a unique, ephemeral correlation ID. * @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. */ getDataMap(scope: string, requestBody: { [key: string]: DataMapKey; }, observe?: 'body', reportProgress?: boolean): Observable<GetDataMapResponse>; getDataMap(scope: string, requestBody: { [key: string]: DataMapKey; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetDataMapResponse>>; getDataMap(scope: string, requestBody: { [key: string]: DataMapKey; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetDataMapResponse>>; /** * [EXPERIMENTAL] GetStructuredResultData: Get structured result data * Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. * @param scope The scope from which to retrieve data items. * @param requestBody The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. * @param asAt The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. * @param maxAge The duration of the look-back window in ISO8601 time interval format, for example \'P1Y2M3DT4H30M\' (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved. * @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. */ getStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, maxAge?: string, observe?: 'body', reportProgress?: boolean): Observable<GetStructuredResultDataResponse>; getStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, maxAge?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetStructuredResultDataResponse>>; getStructuredResultData(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, maxAge?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetStructuredResultDataResponse>>; /** * [EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents * Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. * @param scope The scope in which to construct the virtual documents. * @param requestBody The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. * @param asAt The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. * @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. */ getVirtualDocument(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<GetVirtualDocumentResponse>; getVirtualDocument(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetVirtualDocumentResponse>>; getVirtualDocument(scope: string, requestBody: { [key: string]: StructuredResultDataId; }, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetVirtualDocumentResponse>>; /** * [EXPERIMENTAL] UpsertResultValue: Upsert result value * Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. * @param scope The scope in which to construct the virtual documents. * @param requestBody The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. * @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. */ upsertResultValue(scope: string, requestBody: { [key: string]: UpsertResultValuesDataRequest; }, observe?: 'body', reportProgress?: boolean): Observable<UpsertStructuredDataResponse>; upsertResultValue(scope: string, requestBody: { [key: string]: UpsertResultValuesDataRequest; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertStructuredDataResponse>>; upsertResultValue(scope: string, requestBody: { [key: string]: UpsertResultValuesDataRequest; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertStructuredDataResponse>>; /** * [BETA] UpsertStructuredResultData: Upsert structured result data * Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. * @param scope The scope in which to create or update data items. * @param requestBody The set of data items to create or update, keyed by a unique, ephemeral correlation ID. * @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. */ upsertStructuredResultData(scope: string, requestBody: { [key: string]: UpsertStructuredResultDataRequest; }, observe?: 'body', reportProgress?: boolean): Observable<UpsertStructuredDataResponse>; upsertStructuredResultData(scope: string, requestBody: { [key: string]: UpsertStructuredResultDataRequest; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertStructuredDataResponse>>; upsertStructuredResultData(scope: string, requestBody: { [key: string]: UpsertStructuredResultDataRequest; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertStructuredDataResponse>>; static ɵfac: i0.ɵɵFactoryDef<StructuredResultDataService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDef<StructuredResultDataService>; }