@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
164 lines (163 loc) • 10.3 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateCustomEntityTypeRequest } from '../model/createCustomEntityTypeRequest';
import { CustomEntityType } from '../model/customEntityType';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfCustomEntityType } from '../model/pagedResourceListOfCustomEntityType';
import { UpdateCustomEntityTypeRequest } from '../model/updateCustomEntityTypeRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface CreateCustomEntityTypeRequestParams {
/** The payload containing the description of the Custom Entity Type. */
createCustomEntityTypeRequest: CreateCustomEntityTypeRequest;
}
export interface DeleteCustomEntityTypeRequestParams {
/** The identifier for the Custom Entity type, derived from the \"entityTypeName\" provided on creation. */
entityType: string;
}
export interface GetCustomEntityTypeRequestParams {
/** The identifier for the Custom Entity Type, derived from the \"entityTypeName\" provided on creation. */
entityType: string;
/** The AsAt datetime at which to retrieve the definition. */
asAt?: string;
}
export interface ListCustomEntityTypesRequestParams {
/** The asAt datetime at which to list the entities. Defaults to returning the latest version of each Custom Entity Type 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;
/** A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\" */
sortBy?: Array<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, sortBy, and asAt fields must not have changed since the original request. */
page?: string;
}
export interface UpdateCustomEntityTypeRequestParams {
/** The identifier for the Custom Entity Type, derived from the \"entityTypeName\" provided on creation. */
entityType: string;
/** The payload containing the description of the Custom Entity Type. */
updateCustomEntityTypeRequest: UpdateCustomEntityTypeRequest;
}
export declare class CustomEntityTypesService {
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] CreateCustomEntityType: 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.
*/
createCustomEntityType(requestParameters?: CreateCustomEntityTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CustomEntityType>;
createCustomEntityType(requestParameters?: CreateCustomEntityTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CustomEntityType>>;
createCustomEntityType(requestParameters?: CreateCustomEntityTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CustomEntityType>>;
/**
* [EARLY ACCESS] DeleteCustomEntityType: Delete a Custom Entity type.
* Delete a Custom Entity type definition by a specific entityType. This will delete all versions of the definition and all associated Custom Entities.
* @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.
*/
deleteCustomEntityType(requestParameters?: DeleteCustomEntityTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteCustomEntityType(requestParameters?: DeleteCustomEntityTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteCustomEntityType(requestParameters?: DeleteCustomEntityTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type.
* Retrieve a specific Custom Entity Type 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.
*/
getCustomEntityType(requestParameters?: GetCustomEntityTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CustomEntityType>;
getCustomEntityType(requestParameters?: GetCustomEntityTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CustomEntityType>>;
getCustomEntityType(requestParameters?: GetCustomEntityTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CustomEntityType>>;
/**
* [EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types.
* List all Custom Entity Types 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.
*/
listCustomEntityTypes(requestParameters?: ListCustomEntityTypesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfCustomEntityType>;
listCustomEntityTypes(requestParameters?: ListCustomEntityTypesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfCustomEntityType>>;
listCustomEntityTypes(requestParameters?: ListCustomEntityTypesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfCustomEntityType>>;
/**
* [EARLY ACCESS] UpdateCustomEntityType: 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.
*/
updateCustomEntityType(requestParameters?: UpdateCustomEntityTypeRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<CustomEntityType>;
updateCustomEntityType(requestParameters?: UpdateCustomEntityTypeRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<CustomEntityType>>;
updateCustomEntityType(requestParameters?: UpdateCustomEntityTypeRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<CustomEntityType>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CustomEntityTypesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CustomEntityTypesService>;
}