@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
75 lines (74 loc) • 4.82 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { MarketDataFieldConfiguration } from '../model/marketDataFieldConfiguration';
import { UpdateMarketDataFieldConfigurationRequest } from '../model/updateMarketDataFieldConfigurationRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface GetMarketDataFieldConfigurationRequestParams {
/** The market data category. */
marketDataCategory: string;
/** The asAt datetime at which to retrieve the configuration. Defaults to return the latest version if not specified. */
asAt?: string;
}
export interface UpdateMarketDataFieldConfigurationRequestParams {
/** The market data category. */
marketDataCategory: string;
/** The metadata fields to add, update, or remove. */
updateMarketDataFieldConfigurationRequest: UpdateMarketDataFieldConfigurationRequest;
}
export declare class MarketDataFieldConfigurationService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration
* Retrieve the market data field configuration for a given market data category. If the configuration does not yet exist, an empty configuration will be returned.
* @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.
*/
getMarketDataFieldConfiguration(requestParameters?: GetMarketDataFieldConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<MarketDataFieldConfiguration>;
getMarketDataFieldConfiguration(requestParameters?: GetMarketDataFieldConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<MarketDataFieldConfiguration>>;
getMarketDataFieldConfiguration(requestParameters?: GetMarketDataFieldConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<MarketDataFieldConfiguration>>;
/**
* [EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration
* Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions.
* @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.
*/
updateMarketDataFieldConfiguration(requestParameters?: UpdateMarketDataFieldConfigurationRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<MarketDataFieldConfiguration>;
updateMarketDataFieldConfiguration(requestParameters?: UpdateMarketDataFieldConfigurationRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<MarketDataFieldConfiguration>>;
updateMarketDataFieldConfiguration(requestParameters?: UpdateMarketDataFieldConfigurationRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<MarketDataFieldConfiguration>>;
static ɵfac: i0.ɵɵFactoryDeclaration<MarketDataFieldConfigurationService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<MarketDataFieldConfigurationService>;
}