UNPKG

@finbourne/lusid-sdk-angular18

Version:

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

135 lines (134 loc) 8.71 kB
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 interface CreateCustomEntityDefinitionRequestParams { /** The payload containing the description of the Custom Entity type. */ customEntityDefinitionRequest: CustomEntityDefinitionRequest; } export interface GetDefinitionRequestParams { /** The identifier for the Custom Entity type, derived from the \&quot;entityTypeName\&quot; provided on creation. */ entityType: string; /** The AsAt datetime at which to retrieve the definition. */ asAt?: string; } export interface ListCustomEntityDefinitionsRequestParams { /** The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified. */ asAt?: string; /** When paginating, limit the results to this number. Defaults to 100 if not specified. */ limit?: number; /** Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */ filter?: string; /** 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. */ page?: string; } export interface UpdateCustomEntityDefinitionRequestParams { /** The identifier for the Custom Entity type, derived from the \&quot;entityTypeName\&quot; provided on creation. */ entityType: string; /** The payload containing the description of the Custom Entity type. */ updateCustomEntityDefinitionRequest: UpdateCustomEntityDefinitionRequest; } 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 requestParameters * @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(requestParameters?: CreateCustomEntityDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CustomEntityDefinition>; createCustomEntityDefinition(requestParameters?: CreateCustomEntityDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CustomEntityDefinition>>; createCustomEntityDefinition(requestParameters?: CreateCustomEntityDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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 requestParameters * @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(requestParameters?: GetDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CustomEntityDefinition>; getDefinition(requestParameters?: GetDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CustomEntityDefinition>>; getDefinition(requestParameters?: GetDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CustomEntityDefinition>>; /** * [EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions * List all Custom Entity type definitions matching particular criteria. * @param requestParameters * @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(requestParameters?: ListCustomEntityDefinitionsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfCustomEntityDefinition>; listCustomEntityDefinitions(requestParameters?: ListCustomEntityDefinitionsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfCustomEntityDefinition>>; listCustomEntityDefinitions(requestParameters?: ListCustomEntityDefinitionsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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 requestParameters * @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(requestParameters?: UpdateCustomEntityDefinitionRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<CustomEntityDefinition>; updateCustomEntityDefinition(requestParameters?: UpdateCustomEntityDefinitionRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<CustomEntityDefinition>>; updateCustomEntityDefinition(requestParameters?: UpdateCustomEntityDefinitionRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<CustomEntityDefinition>>; static ɵfac: i0.ɵɵFactoryDeclaration<CustomEntityDefinitionsService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<CustomEntityDefinitionsService>; }