@finbourne/lusid-sdk-angular18/lib/.generated/api/schemas.service.d.ts

An Angular (18) 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 { PropertySchema } from '../model/propertySchema';
import { ResourceListOfString } from '../model/resourceListOfString';
import { ResourceListOfValueType } from '../model/resourceListOfValueType';
import { Schema } from '../model/schema';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface GetEntitySchemaRequestParams {
    /** The name of a valid entity */
    entity: string;
}
export interface GetPropertySchemaRequestParams {
    /** One or more property keys for which the schema is requested */
    propertyKeys?: Array<string>;
    /** Optional. The AsAt date of the data */
    asAt?: string;
}
export interface GetValueTypesRequestParams {
    /** Optional. Order the results by these fields. Use use the \&#39;-\&#39; sign to denote descending order e.g. -MyFieldName */
    sortBy?: Array<string>;
    /** Optional. When paginating, limit the number of returned results to this many. */
    limit?: number;
}
export declare class SchemasService {
    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] GetEntitySchema: Get schema
     * Gets the schema and meta-data for a given entity
     * @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.
     */
    getEntitySchema(requestParameters?: GetEntitySchemaRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<Schema>;
    getEntitySchema(requestParameters?: GetEntitySchemaRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<Schema>>;
    getEntitySchema(requestParameters?: GetEntitySchemaRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<Schema>>;
    /**
     * [EARLY ACCESS] GetPropertySchema: Get property schema
     * Get the schemas for the provided list of property keys.
     * @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.
     */
    getPropertySchema(requestParameters?: GetPropertySchemaRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<PropertySchema>;
    getPropertySchema(requestParameters?: GetPropertySchemaRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<PropertySchema>>;
    getPropertySchema(requestParameters?: GetPropertySchemaRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<PropertySchema>>;
    /**
     * [EARLY ACCESS] GetValueTypes: Get value types
     * Gets the available value types for which a schema is available.
     * @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.
     */
    getValueTypes(requestParameters?: GetValueTypesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfValueType>;
    getValueTypes(requestParameters?: GetValueTypesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfValueType>>;
    getValueTypes(requestParameters?: GetValueTypesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfValueType>>;
    /**
     * [EARLY ACCESS] ListEntities: List entities
     * List all available entities for which schema information is available.
     * @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.
     */
    listEntities(observe?: 'body', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<ResourceListOfString>;
    listEntities(observe?: 'response', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpResponse<ResourceListOfString>>;
    listEntities(observe?: 'events', reportProgress?: boolean, options?: {
        httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
        context?: HttpContext;
        transferCache?: boolean;
    }): Observable<HttpEvent<ResourceListOfString>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<SchemasService, [null, { optional: true; }, { optional: true; }]>;
    static ɵprov: i0.ɵɵInjectableDeclaration<SchemasService>;
}