@finbourne/lusid-sdk-angular6
Version:
An angular (6+) SDK for secure access to the LUSID® by FINBOURNE web API
60 lines (59 loc) • 4.91 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeleteQuotesResponse } from '../model/deleteQuotesResponse';
import { ResourceListOfQuote } from '../model/resourceListOfQuote';
import { UpsertQuoteRequest } from '../model/upsertQuoteRequest';
import { UpsertQuotesResponse } from '../model/upsertQuotesResponse';
import { Configuration } from '../configuration';
export declare class QuotesService {
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(consumes);
/**
* Delete a quote
* Delete the specified quote. In order for a quote to be deleted the id and effectiveFrom date must exactly match.
* @param scope The scope of the quote
* @param id The quote id
* @param effectiveFrom The date/time from which the quote is effective
* @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.
*/
deleteQuote(scope: string, id?: string, effectiveFrom?: Date, observe?: 'body', reportProgress?: boolean): Observable<DeleteQuotesResponse>;
deleteQuote(scope: string, id?: string, effectiveFrom?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeleteQuotesResponse>>;
deleteQuote(scope: string, id?: string, effectiveFrom?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeleteQuotesResponse>>;
/**
* Get quotes
* Get quotes effective at the specified date/time (if any). An optional maximum age of quotes can be specified, and is infinite by default. Quotes which are older than this at the time of the effective date/time will not be returned. MaxAge is a duration of time represented in an ISO8601 format, eg. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). The results are paged, and by default the 1st page of results is returned with a limit of 100 results per page
* @param scope The scope of the quotes
* @param quoteIds The ids of the quotes
* @param effectiveAt Optional. The date/time from which the quotes are effective
* @param asAt Optional. The 'AsAt' date/time
* @param maxAge Optional. The quote staleness tolerance
* @param page Optional. The page of results to return
* @param limit Optional. The number of results per page
* @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.
*/
getQuotes(scope: string, quoteIds?: Array<string>, effectiveAt?: Date, asAt?: Date, maxAge?: string, page?: number, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfQuote>;
getQuotes(scope: string, quoteIds?: Array<string>, effectiveAt?: Date, asAt?: Date, maxAge?: string, page?: number, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfQuote>>;
getQuotes(scope: string, quoteIds?: Array<string>, effectiveAt?: Date, asAt?: Date, maxAge?: string, page?: number, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfQuote>>;
/**
* Add quotes
* Add quotes effective at the specified time. If a quote is added with the same id (and is effective at the same time) as an existing quote, then the more recently added quote will be returned when queried
* @param scope The scope of the quotes
* @param quotes The quotes to add
* @param effectiveAt Optional. The date/time from which the quotes are effective
* @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.
*/
upsertQuotes(scope: string, quotes?: Array<UpsertQuoteRequest>, effectiveAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<UpsertQuotesResponse>;
upsertQuotes(scope: string, quotes?: Array<UpsertQuoteRequest>, effectiveAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertQuotesResponse>>;
upsertQuotes(scope: string, quotes?: Array<UpsertQuoteRequest>, effectiveAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertQuotesResponse>>;
}