@finbourne/lusid-sdk-angular16

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CreateDataTypeRequest } from '../model/createDataTypeRequest'; import { DataType } from '../model/dataType'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; 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 { UpdateReferenceDataRequest } from '../model/updateReferenceDataRequest'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class DataTypesService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * [EARLY ACCESS] CreateDataType: Create data type definition * Create a new data type definition Data types cannot be created in either the \"default\" or \"system\" 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, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DataType>; createDataType(createDataTypeRequest?: CreateDataTypeRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DataType>>; createDataType(createDataTypeRequest?: CreateDataTypeRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DataType>>; /** * DeleteDataType: Delete a data type definition. * Delete an existing data type definition. Data types cannot be deleted in either the \"default\" or \"system\" scopes, scopes beginning with \"LUSID-\", or data types that are in use on a property definition. * @param scope The scope of the data type * @param code The code 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. */ deleteDataType(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DeletedEntityResponse>; deleteDataType(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteDataType(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * 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?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DataType>; getDataType(scope: string, code: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DataType>>; getDataType(scope: string, code: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): 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 \"schema eq \'string\'\" 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?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ResourceListOfIUnitDefinitionDto>; getUnitsFromDataType(scope: string, code: string, units?: Array<string>, filter?: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ResourceListOfIUnitDefinitionDto>>; getUnitsFromDataType(scope: string, code: string, units?: Array<string>, filter?: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): 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, sortBy and asAt fields must not have changed since the original request. * @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 \"id.scope eq \'myscope\'\", to filter on Schema, use \"schema eq \'string\'\", to filter on AcceptableValues use \"acceptableValues any (~ eq \'value\')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. * @param sortBy A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" * @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?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<PagedResourceListOfDataTypeSummary>; listDataTypeSummaries(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<PagedResourceListOfDataTypeSummary>>; listDataTypeSummaries(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): 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 \"system\" scope * @param sortBy Optional. Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName * @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 \"displayName eq \'string\'\" 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?: string, includeSystem?: boolean, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<ResourceListOfDataType>; listDataTypes(scope: string, asAt?: string, includeSystem?: boolean, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<ResourceListOfDataType>>; listDataTypes(scope: string, asAt?: string, includeSystem?: boolean, sortBy?: Array<string>, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): 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, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DataType>; updateDataType(scope: string, code: string, updateDataTypeRequest: UpdateDataTypeRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DataType>>; updateDataType(scope: string, code: string, updateDataTypeRequest: UpdateDataTypeRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DataType>>; /** * [EARLY ACCESS] UpdateReferenceData: Update all reference data on a data type, includes the reference values, the field definitions, field values * Replaces the whole set of reference data * @param scope The scope of the data type * @param code The code of the data type * @param updateReferenceDataRequest The updated reference data * @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. */ updateReferenceData(scope: string, code: string, updateReferenceDataRequest: UpdateReferenceDataRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DataType>; updateReferenceData(scope: string, code: string, updateReferenceDataRequest: UpdateReferenceDataRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DataType>>; updateReferenceData(scope: string, code: string, updateReferenceDataRequest: UpdateReferenceDataRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): 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, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DataType>; updateReferenceValues(scope: string, code: string, fieldValue: Array<FieldValue>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DataType>>; updateReferenceValues(scope: string, code: string, fieldValue: Array<FieldValue>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DataType>>; static ɵfac: i0.ɵɵFactoryDeclaration<DataTypesService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<DataTypesService>; }