@finbourne/lusid-sdk-angular8

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { AnnulQuotesResponse } from '../model/annulQuotesResponse'; import { GetQuotesResponse } from '../model/getQuotesResponse'; import { QuoteAccessMetadataRule } from '../model/quoteAccessMetadataRule'; import { QuoteId } from '../model/quoteId'; import { QuoteSeriesId } from '../model/quoteSeriesId'; import { ResourceListOfQuote } from '../model/resourceListOfQuote'; import { ResourceListOfQuoteAccessMetadataRule } from '../model/resourceListOfQuoteAccessMetadataRule'; import { UpsertQuoteAccessMetadataRuleRequest } from '../model/upsertQuoteAccessMetadataRuleRequest'; import { UpsertQuoteRequest } from '../model/upsertQuoteRequest'; import { UpsertQuotesResponse } from '../model/upsertQuotesResponse'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; 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; /** * [EXPERIMENTAL] DeleteQuoteAccessMetadataRule: Delete a Quote Access Metadata Rule * Delete the Quote Access Metadata Rule that exactly matches the provided identifier parts * @param scope The scope of the Quote Access Metadata Rule to retrieve. * @param provider The Provider of the rule * @param priceSource The PriceSource of the rule * @param instrumentIdType The InstrumentIdType of the rule * @param instrumentId The InstrumentId of the rule * @param quoteType The QuoteType of the rule * @param field The Field of the rule * @param effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found * @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. */ deleteQuoteAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, observe?: 'body', reportProgress?: boolean): Observable<QuoteAccessMetadataRule>; deleteQuoteAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<QuoteAccessMetadataRule>>; deleteQuoteAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<QuoteAccessMetadataRule>>; /** * DeleteQuotes: Delete quotes * Delete one or more specified quotes from a single scope. A quote is identified by its unique id which includes information about the type of quote as well as the exact effective datetime (to the microsecond) from which it became valid. In the request each quote must 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 quote in the response. The response will return both the collection of successfully deleted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be deleted. It is important to always check the failed set for any unsuccessful results. * @param scope The scope of the quotes to delete. * @param requestBody The quotes to delete keyed by a unique 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. */ deleteQuotes(scope: string, requestBody?: { [key: string]: QuoteId; }, observe?: 'body', reportProgress?: boolean): Observable<AnnulQuotesResponse>; deleteQuotes(scope: string, requestBody?: { [key: string]: QuoteId; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<AnnulQuotesResponse>>; deleteQuotes(scope: string, requestBody?: { [key: string]: QuoteId; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<AnnulQuotesResponse>>; /** * [EARLY ACCESS] GetQuotes: Get quotes * Get one or more quotes from a single scope. Each quote can be identified by its time invariant quote series id. For each quote series id LUSID will return the most recent quote with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for a quote from the specified effective datetime. LUSID will return the most recent quote within this window. In the request each quote series id must 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 quote in the response. The response will return three collections. One, the successfully retrieved quotes. Two, those that had a valid quote series id but could not be found. Three, those that failed because LUSID could not construct a valid quote series id from the request. For the quotes that failed or could not be found a reason will be provided explaining why the quote could not be retrieved. It is important to always check the failed and not found sets for any unsuccessful results. The maximum number of quotes that this method can get per request is 2,000. * @param scope The scope of the quotes to retrieve. * @param effectiveAt The effective datetime or cut label at which to retrieve the quotes. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the quotes. Defaults to return the latest version of each quote if not specified. * @param maxAge The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime or cut label to generate a effective datetime window inside which a quote must exist to be retrieved. * @param requestBody The time invariant quote series ids of the quotes to retrieve. These need to be keyed by a unique correlation id allowing the retrieved quote to be identified in the response. * @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, effectiveAt?: string, asAt?: Date, maxAge?: string, requestBody?: { [key: string]: QuoteSeriesId; }, observe?: 'body', reportProgress?: boolean): Observable<GetQuotesResponse>; getQuotes(scope: string, effectiveAt?: string, asAt?: Date, maxAge?: string, requestBody?: { [key: string]: QuoteSeriesId; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<GetQuotesResponse>>; getQuotes(scope: string, effectiveAt?: string, asAt?: Date, maxAge?: string, requestBody?: { [key: string]: QuoteSeriesId; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<GetQuotesResponse>>; /** * [EXPERIMENTAL] GetQuotesAccessMetadataRule: Get a quote access metadata rule * Get a specific quote access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule * @param scope The scope of the Quote Access Metadata Rule to retrieve. * @param provider The Provider of the rule * @param priceSource The PriceSource of the rule * @param instrumentIdType The InstrumentIdType of the rule * @param instrumentId The InstrumentId of the rule * @param quoteType The QuoteType of the rule * @param field The Field of the rule * @param effectiveAt The effective date of the rule * @param asAt The asAt datetime at which to retrieve the access metadata rule. Defaults to return 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. */ getQuotesAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<QuoteAccessMetadataRule>; getQuotesAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<QuoteAccessMetadataRule>>; getQuotesAccessMetadataRule(scope: string, provider?: string, priceSource?: string, instrumentIdType?: string, instrumentId?: string, quoteType?: string, field?: string, effectiveAt?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<QuoteAccessMetadataRule>>; /** * [DEPRECATED] ListQuotes: List quotes * List all the quotes from a single scope at the specified date/time Please use M:Finbourne.WebApi.Controllers.QuotesController.ListQuotesForScope(System.String,System.Nullable{System.DateTimeOffset},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String) - the signature and behaviour of this endpoint will be changing to omit scope * @param scope The scope of the quotes to list. * @param asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. * @param page The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. * @param start When paginating, skip this number of results. * @param limit When paginating, limit the number of returned results to this many. * @param filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @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. */ listQuotes(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfQuote>; listQuotes(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfQuote>>; listQuotes(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfQuote>>; /** * [EXPERIMENTAL] ListQuotesAccessMetadataRules: List all quote access metadata rules in a scope * Get all the quote access metadata rules in the specified scope * @param scope The scope of the Quote Access Metadata Rule to retrieve. * @param asAt The asAt datetime at which to retrieve the access metadata rule. Defaults to return 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. */ listQuotesAccessMetadataRules(scope: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfQuoteAccessMetadataRule>; listQuotesAccessMetadataRules(scope: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfQuoteAccessMetadataRule>>; listQuotesAccessMetadataRules(scope: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfQuoteAccessMetadataRule>>; /** * ListQuotesForScope: List quotes for scope * List all the quotes from a single scope at the specified date/time * @param scope The scope of the quotes to list. * @param asAt The asAt datetime at which to list the quotes. Defaults to latest if not specified. * @param page The pagination token to use to continue listing quotes from a previous call to list quotes. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided. * @param start When paginating, skip this number of results. * @param limit When paginating, limit the number of returned results to this many. * @param filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @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. */ listQuotesForScope(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfQuote>; listQuotesForScope(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfQuote>>; listQuotesForScope(scope: string, asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfQuote>>; /** * [EXPERIMENTAL] UpsertQuoteAccessMetadataRule: Upsert a Quote Access Metadata Rule. This creates or updates the data in LUSID. * Update or insert one Quote Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Quote Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a key can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched * @param scope The scope to use when updating or inserting the Quote Access Metadata Rule. * @param upsertQuoteAccessMetadataRuleRequest The Quote Access Metadata Rule to update or insert * @param effectiveAt The date this rule will effective from * @param effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next \'effectiveAt\' date of the Access Metadata * @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. */ upsertQuoteAccessMetadataRule(scope: string, upsertQuoteAccessMetadataRuleRequest: UpsertQuoteAccessMetadataRuleRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'body', reportProgress?: boolean): Observable<QuoteAccessMetadataRule>; upsertQuoteAccessMetadataRule(scope: string, upsertQuoteAccessMetadataRuleRequest: UpsertQuoteAccessMetadataRuleRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<QuoteAccessMetadataRule>>; upsertQuoteAccessMetadataRule(scope: string, upsertQuoteAccessMetadataRuleRequest: UpsertQuoteAccessMetadataRuleRequest, effectiveAt?: string, effectiveUntil?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<QuoteAccessMetadataRule>>; /** * UpsertQuotes: Upsert quotes * Update or insert one or more quotes in a single scope. A quote will be updated if it already exists and inserted if it does not. In the request each quote must 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 quote in the response. The response will return both the collection of successfully updated or inserted quotes, as well as those that failed. For the failures a reason will be provided explaining why the quote could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. The maximum number of quotes that this method can upsert per request is 2,000. * @param scope The scope to use when updating or inserting the quotes. * @param requestBody The quotes to update or insert keyed by a unique 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. */ upsertQuotes(scope: string, requestBody?: { [key: string]: UpsertQuoteRequest; }, observe?: 'body', reportProgress?: boolean): Observable<UpsertQuotesResponse>; upsertQuotes(scope: string, requestBody?: { [key: string]: UpsertQuoteRequest; }, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertQuotesResponse>>; upsertQuotes(scope: string, requestBody?: { [key: string]: UpsertQuoteRequest; }, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertQuotesResponse>>; static ɵfac: i0.ɵɵFactoryDef<QuotesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDef<QuotesService>; }