@finbourne/lusid-sdk-angular6/lib/generated/api/results.service.d.ts

An angular (6+) SDK for secure access to the LUSID® by FINBOURNE web API

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateResults } from '../model/createResults';
import { Results } from '../model/results';
import { Configuration } from '../configuration';
export declare class ResultsService {
    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);
    /**
     * Get results
     * Retrieve some previously stored results
     * @param scope The scope of the data
     * @param key The key that identifies the data
     * @param date The date for which the data was loaded
     * @param asAt Optional. The AsAt date of the data
     * @param sortBy Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName
     * @param start Optional. When paginating, skip this number of results
     * @param limit Optional. When paginating, limit the number of returned results to this many.
     * @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.
     */
    getResults(scope: string, key: string, date: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<Results>;
    getResults(scope: string, key: string, date: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Results>>;
    getResults(scope: string, key: string, date: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Results>>;
    /**
     * Upsert results
     * Upsert pre-calculated results against a specified scope/key/date combination
     * @param scope The scope of the data
     * @param key The key that identifies the data
     * @param date The date for which the data is relevant
     * @param request The results to upload
     * @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.
     */
    upsertResults(scope: string, key: string, date: Date, request?: CreateResults, observe?: 'body', reportProgress?: boolean): Observable<Results>;
    upsertResults(scope: string, key: string, date: Date, request?: CreateResults, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Results>>;
    upsertResults(scope: string, key: string, date: Date, request?: CreateResults, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Results>>;
}