UNPKG

@finbourne/lusid-sdk-angular8

Version:

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

117 lines (116 loc) 11.1 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CreateDataTypeRequest } from '../model/createDataTypeRequest'; import { DataType } from '../model/dataType'; import { FieldValue } from '../model/fieldValue'; import { PagedResourceListOfDataTypeSummary } from '../model/pagedResourceListOfDataTypeSummary'; import { ResourceListOfDataType } from '../model/resourceListOfDataType'; import { ResourceListOfIUnitDefinitionDto } from '../model/resourceListOfIUnitDefinitionDto'; import { UpdateDataTypeRequest } from '../model/updateDataTypeRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class DataTypesService { 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] CreateDataType: Create data type definition * Create a new data type definition Data types cannot be created in either the \&quot;default\&quot; or \&quot;system\&quot; scopes. * @param createDataTypeRequest The definition of the new data type * @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. */ createDataType(createDataTypeRequest?: CreateDataTypeRequest, observe?: 'body', reportProgress?: boolean): Observable<DataType>; createDataType(createDataTypeRequest?: CreateDataTypeRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DataType>>; createDataType(createDataTypeRequest?: CreateDataTypeRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DataType>>; /** * GetDataType: Get data type definition * Get the definition of a specified data type * @param scope The scope of the data type * @param code The code of the data type * @param asAt The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition 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. */ getDataType(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<DataType>; getDataType(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DataType>>; getDataType(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DataType>>; /** * [EARLY ACCESS] GetUnitsFromDataType: Get units from data type * Get the definitions of the specified units associated bound to a specific data type * @param scope The scope of the data type * @param code The code of the data type * @param units One or more unit identifiers for which the definition is being requested * @param filter Optional. Expression to filter the result set. For example, to filter on the Schema, use \&quot;schema eq \&#39;string\&#39;\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param asAt Optional. The as at of the requested data type * @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. */ getUnitsFromDataType(scope: string, code: string, units?: Array<string>, filter?: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfIUnitDefinitionDto>; getUnitsFromDataType(scope: string, code: string, units?: Array<string>, filter?: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfIUnitDefinitionDto>>; getUnitsFromDataType(scope: string, code: string, units?: Array<string>, filter?: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfIUnitDefinitionDto>>; /** * [EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data * List all data type summaries * @param asAt The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified. * @param page The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the 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 results to this number. Defaults to 100 if not specified. * @param filter Optional. Expression to filter the result set. For example, to filter on the Scope, use \&quot;id.scope eq \&#39;myscope\&#39;\&quot;, to filter on Schema, use \&quot;schema eq \&#39;string\&#39;\&quot;, to filter on AcceptableValues use \&quot;acceptableValues any (~ eq \&#39;value\&#39;)\&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param sortBy Sort the results by these fields. Use use the \&#39;-\&#39; sign to denote descending allocation e.g. -MyFieldName. * @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. */ listDataTypeSummaries(asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<PagedResourceListOfDataTypeSummary>; listDataTypeSummaries(asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PagedResourceListOfDataTypeSummary>>; listDataTypeSummaries(asAt?: Date, page?: string, start?: number, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PagedResourceListOfDataTypeSummary>>; /** * ListDataTypes: List data types * List all data types in a specified scope * @param scope The requested scope of the data types * @param asAt The as at of the requested data types * @param includeSystem Whether to additionally include those data types in the \&quot;system\&quot; scope * @param sortBy Optional. Order the results by these fields. Use use the \&#39;-\&#39; 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 filter Optional. Expression to filter the result set. For example, to filter on the Display Name, use \&quot;displayName eq \&#39;string\&#39;\&quot; 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. */ listDataTypes(scope: string, asAt?: Date, includeSystem?: boolean, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfDataType>; listDataTypes(scope: string, asAt?: Date, includeSystem?: boolean, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfDataType>>; listDataTypes(scope: string, asAt?: Date, includeSystem?: boolean, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfDataType>>; /** * [EARLY ACCESS] UpdateDataType: Update data type definition * Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types * @param scope The scope of the data type * @param code The code of the data type * @param updateDataTypeRequest The updated definition of the data type * @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. */ updateDataType(scope: string, code: string, updateDataTypeRequest: UpdateDataTypeRequest, observe?: 'body', reportProgress?: boolean): Observable<DataType>; updateDataType(scope: string, code: string, updateDataTypeRequest: UpdateDataTypeRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DataType>>; updateDataType(scope: string, code: string, updateDataTypeRequest: UpdateDataTypeRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DataType>>; /** * [EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type * Replaces the whole set of reference values * @param scope The scope of the data type * @param code The code of the data type * @param fieldValue The updated reference values * @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. */ updateReferenceValues(scope: string, code: string, fieldValue: Array<FieldValue>, observe?: 'body', reportProgress?: boolean): Observable<DataType>; updateReferenceValues(scope: string, code: string, fieldValue: Array<FieldValue>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DataType>>; updateReferenceValues(scope: string, code: string, fieldValue: Array<FieldValue>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DataType>>; static ɵfac: i0.ɵɵFactoryDef<DataTypesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDef<DataTypesService>; }