@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
129 lines (128 loc) • 8.45 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { BatchDeleteRelationalDataResponse } from '../model/batchDeleteRelationalDataResponse';
import { BatchUpsertRelationalDatasetsResponse } from '../model/batchUpsertRelationalDatasetsResponse';
import { DeleteRelationalDataPointRequest } from '../model/deleteRelationalDataPointRequest';
import { PagedResourceListOfRelationalDataPointResponse } from '../model/pagedResourceListOfRelationalDataPointResponse';
import { QueryRelationalDatasetRequest } from '../model/queryRelationalDatasetRequest';
import { UpsertRelationalDataPointRequest } from '../model/upsertRelationalDataPointRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface BatchDeleteRelationalDataRequestParams {
/** The Scope of the relational dataset definition. */
relationalDatasetDefinitionScope: string;
/** The Code of the relational dataset definition. */
relationalDatasetDefinitionCode: string;
/** The Delete Request. */
requestBody: {
[key: string]: DeleteRelationalDataPointRequest;
};
/** Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. */
successMode?: string;
}
export interface BatchUpsertRelationalDataRequestParams {
/** The Scope of the relational dataset definition. */
relationalDatasetDefinitionScope: string;
/** The Code of the relational dataset definition. */
relationalDatasetDefinitionCode: string;
/** The DataPoints to upsert. */
requestBody: {
[key: string]: UpsertRelationalDataPointRequest;
};
/** Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. */
successMode?: string;
}
export interface QueryRelationalDataRequestParams {
/** The Scope of the relational dataset definition. */
relationalDatasetDefinitionScope: string;
/** The Code of the relational dataset definition. */
relationalDatasetDefinitionCode: string;
/** The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified. */
asAt?: string;
/** The effective datetime or cut label at which to query the datasets. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The pagination token to use to continue query datasets. This value is returned from the previous call. If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** The query request. */
queryRelationalDatasetRequest?: QueryRelationalDatasetRequest;
}
export declare class RelationalDatasetsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition.
* Batch Delete Relational Data Points for a given Relational Dataset Definition.
* @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.
*/
batchDeleteRelationalData(requestParameters?: BatchDeleteRelationalDataRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<BatchDeleteRelationalDataResponse>;
batchDeleteRelationalData(requestParameters?: BatchDeleteRelationalDataRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<BatchDeleteRelationalDataResponse>>;
batchDeleteRelationalData(requestParameters?: BatchDeleteRelationalDataRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<BatchDeleteRelationalDataResponse>>;
/**
* BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition.
* Batch Upsert Relational Data Points for a given Relational Dataset Definition.
* @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.
*/
batchUpsertRelationalData(requestParameters?: BatchUpsertRelationalDataRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<BatchUpsertRelationalDatasetsResponse>;
batchUpsertRelationalData(requestParameters?: BatchUpsertRelationalDataRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<BatchUpsertRelationalDatasetsResponse>>;
batchUpsertRelationalData(requestParameters?: BatchUpsertRelationalDataRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<BatchUpsertRelationalDatasetsResponse>>;
/**
* QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition.
* Query Relational Data Points for a given Relational Dataset Definition.
* @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.
*/
queryRelationalData(requestParameters?: QueryRelationalDataRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfRelationalDataPointResponse>;
queryRelationalData(requestParameters?: QueryRelationalDataRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfRelationalDataPointResponse>>;
queryRelationalData(requestParameters?: QueryRelationalDataRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfRelationalDataPointResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<RelationalDatasetsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<RelationalDatasetsService>;
}