@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
73 lines (72 loc) • 5.66 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { TranslateInstrumentDefinitionsRequest } from '../model/translateInstrumentDefinitionsRequest';
import { TranslateInstrumentDefinitionsResponse } from '../model/translateInstrumentDefinitionsResponse';
import { TranslateTradeTicketRequest } from '../model/translateTradeTicketRequest';
import { TranslateTradeTicketsResponse } from '../model/translateTradeTicketsResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface TranslateInstrumentDefinitionsRequestParams {
/** The definitions of the instruments to translate along with the target dialect. */
translateInstrumentDefinitionsRequest: TranslateInstrumentDefinitionsRequest;
}
export interface TranslateTradeTicketsRequestParams {
/** The definitions of the trade ticket to translate along with the target dialect. */
translateTradeTicketRequest: TranslateTradeTicketRequest;
}
export declare class TranslationService {
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] TranslateInstrumentDefinitions: Translate instruments
* Translates one or more instruments into the given target dialect. In the request each instrument definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each instrument in the response. Any instrument that is not already in the LUSID dialect should be given as an ExoticInstrument. The response will return both the collection of successfully translated instruments in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the instrument could not be updated or inserted.
* @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.
*/
translateInstrumentDefinitions(requestParameters?: TranslateInstrumentDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TranslateInstrumentDefinitionsResponse>;
translateInstrumentDefinitions(requestParameters?: TranslateInstrumentDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TranslateInstrumentDefinitionsResponse>>;
translateInstrumentDefinitions(requestParameters?: TranslateInstrumentDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TranslateInstrumentDefinitionsResponse>>;
/**
* [EXPERIMENTAL] TranslateTradeTickets: Translate trade ticket
* Translates one or more trade tickets into the given target dialect. In the request each trade ticket definition should be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each trade ticket in the response. The response will return both the collection of successfully translated trade tickets in the target dialect, as well as those that failed. For the failures a reason will be provided explaining why the trade ticket could not be updated or inserted.
* @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.
*/
translateTradeTickets(requestParameters?: TranslateTradeTicketsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<TranslateTradeTicketsResponse>;
translateTradeTickets(requestParameters?: TranslateTradeTicketsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<TranslateTradeTicketsResponse>>;
translateTradeTickets(requestParameters?: TranslateTradeTicketsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<TranslateTradeTicketsResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<TranslationService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<TranslationService>;
}