@finbourne/lusid-sdk-angular8
Version:
An angular (8+) SDK for secure access to the LUSID® by FINBOURNE web API
79 lines (78 loc) • 9.08 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { InstrumentMatch } from '../model/instrumentMatch';
import { InstrumentSearchProperty } from '../model/instrumentSearchProperty';
import { PagedResourceListOfPortfolioGroupSearchResult } from '../model/pagedResourceListOfPortfolioGroupSearchResult';
import { PagedResourceListOfPortfolioSearchResult } from '../model/pagedResourceListOfPortfolioSearchResult';
import { PagedResourceListOfPropertyDefinitionSearchResult } from '../model/pagedResourceListOfPropertyDefinitionSearchResult';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class SearchService {
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;
/**
* [EARLY ACCESS] InstrumentsSearch: Instruments search
* Search across all instruments that have been mastered in LUSID. Optionally augment the results with instruments from an external symbology service, currently OpenFIGI.
* @param instrumentSearchProperty A collection of instrument properties to search for. LUSID will return instruments for any matched properties.
* @param masteredEffectiveAt The effective datetime or cut label to use when searching mastered instruments. This parameter has no effect on instruments that have not been mastered within LUSID. Defaults to the current LUSID system datetime if not specified.
* @param masteredOnly If set to true, only search over instruments that have been mastered within LUSID. Defaults to false.
* @param scope The scope in which the instrument lies.
* @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.
*/
instrumentsSearch(instrumentSearchProperty: Array<InstrumentSearchProperty>, masteredEffectiveAt?: string, masteredOnly?: boolean, scope?: string, observe?: 'body', reportProgress?: boolean): Observable<Array<InstrumentMatch>>;
instrumentsSearch(instrumentSearchProperty: Array<InstrumentSearchProperty>, masteredEffectiveAt?: string, masteredOnly?: boolean, scope?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<Array<InstrumentMatch>>>;
instrumentsSearch(instrumentSearchProperty: Array<InstrumentSearchProperty>, masteredEffectiveAt?: string, masteredOnly?: boolean, scope?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<Array<InstrumentMatch>>>;
/**
* SearchPortfolioGroups: Search Portfolio Groups
* Search through all portfolio groups
* @param search A parameter used for searching any portfolio group field. Wildcards(*) are supported at the end of words (e.g. \'Port*\'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param filter Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq \'string\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
* @param limit When paginating, only return this number of records
* @param page Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
* @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.
*/
searchPortfolioGroups(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfPortfolioGroupSearchResult>;
searchPortfolioGroups(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfPortfolioGroupSearchResult>>;
searchPortfolioGroups(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfPortfolioGroupSearchResult>>;
/**
* SearchPortfolios: Search Portfolios
* Search through all portfolios
* @param search A parameter used for searching any portfolio field. Wildcards(*) are supported at the end of words (e.g. \'Port*\'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param filter Expression to filter the result set. For example, to filter on the portfolio Type, use \"type eq \'Transaction\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
* @param limit When paginating, only return this number of records
* @param page Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
* @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.
*/
searchPortfolios(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfPortfolioSearchResult>;
searchPortfolios(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfPortfolioSearchResult>>;
searchPortfolios(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfPortfolioSearchResult>>;
/**
* SearchProperties: Search Property Definitions
* Search through all Property Definitions
* @param search A parameter used for searching any field. Wildcards(*) are supported at the end of words (e.g. \'Port*\'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param filter Expression to filter the result set. For example, to filter on the Value Type, use \"valueType eq \'string\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName
* @param limit When paginating, only return this number of records
* @param page Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied.
* @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.
*/
searchProperties(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfPropertyDefinitionSearchResult>;
searchProperties(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfPropertyDefinitionSearchResult>>;
searchProperties(search?: string, filter?: string, sortBy?: string, limit?: number, page?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfPropertyDefinitionSearchResult>>;
static ɵfac: i0.ɵɵFactoryDef<SearchService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDef<SearchService>;
}