@finbourne/lusid-sdk-angular6
Version:
An angular (6+) SDK for secure access to the LUSID® by FINBOURNE web API
76 lines (75 loc) • 6.72 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { AggregationRequest } from '../model/aggregationRequest';
import { ListAggregationResponse } from '../model/listAggregationResponse';
import { NestedAggregationResponse } from '../model/nestedAggregationResponse';
import { Configuration } from '../configuration';
export declare class AggregationService {
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);
/**
* Aggregate data in a portfolio group
* Aggregate data sourced from the specified portfolio group
* @param scope The scope of the portfolio group
* @param code The code of the portfolio group
* @param request The request specifying the parameters of the aggregation
* @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.
*/
getAggregationByGroup(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ListAggregationResponse>;
getAggregationByGroup(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ListAggregationResponse>>;
getAggregationByGroup(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ListAggregationResponse>>;
/**
* Aggregate data in a portfolio
* Aggregate data sourced from the specified portfolio
* @param scope The scope of the portfolio
* @param code The code of the portfolio
* @param request The request specifying the parameters of the aggregation
* @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.
*/
getAggregationByPortfolio(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ListAggregationResponse>;
getAggregationByPortfolio(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ListAggregationResponse>>;
getAggregationByPortfolio(scope: string, code: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ListAggregationResponse>>;
/**
* Aggregate using result data
* Aggregate data from a previously-run Result data set into a flat row of results
* @param scope The scope of the Result data set
* @param resultsKey The key of the Result data set
* @param request The request specifying the parameters of the aggregation
* @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.
*/
getAggregationByResultSet(scope: string, resultsKey: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'body', reportProgress?: boolean): Observable<ListAggregationResponse>;
getAggregationByResultSet(scope: string, resultsKey: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ListAggregationResponse>>;
getAggregationByResultSet(scope: string, resultsKey: string, request?: AggregationRequest, sortBy?: Array<string>, start?: number, limit?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ListAggregationResponse>>;
/**
* Aggregate data in a portfolio group, as nested
* Obsolete - Aggregate data sourced from the specified portfolio group into a nested structure. Data is nested following the group-by specifications.
* @param scope The scope of the portfolio group
* @param code The code of the portfolio group
* @param request The request specifying the parameters of the aggregation
* @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.
*/
getNestedAggregationByGroup(scope: string, code: string, request?: AggregationRequest, observe?: 'body', reportProgress?: boolean): Observable<NestedAggregationResponse>;
getNestedAggregationByGroup(scope: string, code: string, request?: AggregationRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<NestedAggregationResponse>>;
getNestedAggregationByGroup(scope: string, code: string, request?: AggregationRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<NestedAggregationResponse>>;
}