@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
102 lines (101 loc) • 7.86 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CustomEntityDefinition } from '../model/customEntityDefinition';
import { CustomEntityDefinitionRequest } from '../model/customEntityDefinitionRequest';
import { PagedResourceListOfCustomEntityDefinition } from '../model/pagedResourceListOfCustomEntityDefinition';
import { UpdateCustomEntityDefinitionRequest } from '../model/updateCustomEntityDefinitionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class CustomEntityDefinitionsService {
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] CreateCustomEntityDefinition: Define a new Custom Entity type.
* The API will return a Bad Request if the Custom Entity type already exists.
* @param customEntityDefinitionRequest The payload containing the description of the Custom Entity 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.
*/
createCustomEntityDefinition(customEntityDefinitionRequest: CustomEntityDefinitionRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CustomEntityDefinition>;
createCustomEntityDefinition(customEntityDefinitionRequest: CustomEntityDefinitionRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CustomEntityDefinition>>;
createCustomEntityDefinition(customEntityDefinitionRequest: CustomEntityDefinitionRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CustomEntityDefinition>>;
/**
* [EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.
* Retrieve a CustomEntityDefinition by a specific entityType at a point in AsAt time
* @param entityType The identifier for the Custom Entity type, derived from the \"entityTypeName\" provided on creation.
* @param asAt The AsAt datetime at which to retrieve the definition.
* @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.
*/
getDefinition(entityType: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CustomEntityDefinition>;
getDefinition(entityType: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CustomEntityDefinition>>;
getDefinition(entityType: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CustomEntityDefinition>>;
/**
* [EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions
* List all Custom Entity type definitions matching particular criteria.
* @param asAt The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
* @param limit When paginating, limit the results to this number. Defaults to 100 if not specified.
* @param filter Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
* @param page The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
* @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.
*/
listCustomEntityDefinitions(asAt?: string, limit?: number, filter?: string, page?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfCustomEntityDefinition>;
listCustomEntityDefinitions(asAt?: string, limit?: number, filter?: string, page?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfCustomEntityDefinition>>;
listCustomEntityDefinitions(asAt?: string, limit?: number, filter?: string, page?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfCustomEntityDefinition>>;
/**
* [EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.
* The API will return a Bad Request if the Custom Entity type does not exist.
* @param entityType The identifier for the Custom Entity type, derived from the \"entityTypeName\" provided on creation.
* @param updateCustomEntityDefinitionRequest The payload containing the description of the Custom Entity 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.
*/
updateCustomEntityDefinition(entityType: string, updateCustomEntityDefinitionRequest: UpdateCustomEntityDefinitionRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<CustomEntityDefinition>;
updateCustomEntityDefinition(entityType: string, updateCustomEntityDefinitionRequest: UpdateCustomEntityDefinitionRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<CustomEntityDefinition>>;
updateCustomEntityDefinition(entityType: string, updateCustomEntityDefinitionRequest: UpdateCustomEntityDefinitionRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<CustomEntityDefinition>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CustomEntityDefinitionsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CustomEntityDefinitionsService>;
}