@finbourne/lusid-sdk-angular16/lib/.generated/api/customEntityTypes.service.d.ts

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

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 { PagedResourceListOfCustomEntityType } from '../model/pagedResourceListOfCustomEntityType';
import { UpdateCustomEntityTypeRequest } from '../model/updateCustomEntityTypeRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
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 createCustomEntityTypeRequest 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.
     */
    createCustomEntityType(createCustomEntityTypeRequest: CreateCustomEntityTypeRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<CustomEntityType>;
    createCustomEntityType(createCustomEntityTypeRequest: CreateCustomEntityTypeRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<CustomEntityType>>;
    createCustomEntityType(createCustomEntityTypeRequest: CreateCustomEntityTypeRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<CustomEntityType>>;
    /**
     * [EARLY ACCESS] GetCustomEntityType: Get a Custom Entity Type.
     * Retrieve a specific Custom Entity Type at a point in AsAt time.
     * @param entityType The identifier for the Custom Entity Type, derived from the \&quot;entityTypeName\&quot; 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.
     */
    getCustomEntityType(entityType: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<CustomEntityType>;
    getCustomEntityType(entityType: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<CustomEntityType>>;
    getCustomEntityType(entityType: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<CustomEntityType>>;
    /**
     * [EARLY ACCESS] ListCustomEntityTypes: List Custom Entity Types.
     * List all Custom Entity Types matching particular criteria.
     * @param asAt The asAt datetime at which to list the entities. Defaults to returning the latest version              of each Custom Entity Type 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 sortBy A list of field names to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;
     * @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, sortBy,              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.
     */
    listCustomEntityTypes(asAt?: string, limit?: number, filter?: string, sortBy?: Array<string>, page?: string, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<PagedResourceListOfCustomEntityType>;
    listCustomEntityTypes(asAt?: string, limit?: number, filter?: string, sortBy?: Array<string>, page?: string, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<PagedResourceListOfCustomEntityType>>;
    listCustomEntityTypes(asAt?: string, limit?: number, filter?: string, sortBy?: Array<string>, page?: string, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): 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 entityType The identifier for the Custom Entity Type, derived from the \&quot;entityTypeName\&quot; provided on creation.
     * @param updateCustomEntityTypeRequest 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.
     */
    updateCustomEntityType(entityType: string, updateCustomEntityTypeRequest: UpdateCustomEntityTypeRequest, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<CustomEntityType>;
    updateCustomEntityType(entityType: string, updateCustomEntityTypeRequest: UpdateCustomEntityTypeRequest, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpResponse<CustomEntityType>>;
    updateCustomEntityType(entityType: string, updateCustomEntityTypeRequest: UpdateCustomEntityTypeRequest, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
    }): Observable<HttpEvent<CustomEntityType>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<CustomEntityTypesService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<CustomEntityTypesService>;
}