@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
107 lines (106 loc) • 8.15 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { Execution } from '../model/execution';
import { ExecutionSetRequest } from '../model/executionSetRequest';
import { PagedResourceListOfExecution } from '../model/pagedResourceListOfExecution';
import { ResourceListOfExecution } from '../model/resourceListOfExecution';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class ExecutionsService {
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] DeleteExecution: Delete execution
* Delete an execution. Deletion will be valid from the execution\'s creation datetime. This means that the execution will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param scope The execution scope.
* @param code The execution\'s code. This, together with the scope uniquely identifies the execution to delete.
* @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.
*/
deleteExecution(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<DeletedEntityResponse>;
deleteExecution(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteExecution(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetExecution: Get Execution
* Fetch a Execution that matches the specified identifier
* @param scope The scope to which the execution belongs.
* @param code The execution\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
* @param propertyKeys A list of property keys from the \"Execution\" domain to decorate onto the execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".
* @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.
*/
getExecution(scope: string, code: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<Execution>;
getExecution(scope: string, code: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<Execution>>;
getExecution(scope: string, code: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<Execution>>;
/**
* ListExecutions: List Executions
* Fetch the last pre-AsAt date version of each execution in scope (does not fetch the entire history).
* @param asAt The asAt datetime at which to retrieve the execution. Defaults to return the latest version of the execution if not specified.
* @param page The pagination token to use to continue listing execution from a previous call to list executions. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
* @param sortBy A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
* @param limit When paginating, limit the number of returned results to this many.
* @param filter Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
* @param propertyKeys A list of property keys from the \"Execution\" domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. \"Execution/system/Name\".
* @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.
*/
listExecutions(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfExecution>;
listExecutions(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfExecution>>;
listExecutions(asAt?: string, page?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfExecution>>;
/**
* UpsertExecutions: Upsert Execution
* Upsert; update existing executions with given ids, or create new executions otherwise.
* @param executionSetRequest The collection of execution requests.
* @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.
*/
upsertExecutions(executionSetRequest?: ExecutionSetRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<ResourceListOfExecution>;
upsertExecutions(executionSetRequest?: ExecutionSetRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<ResourceListOfExecution>>;
upsertExecutions(executionSetRequest?: ExecutionSetRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<ResourceListOfExecution>>;
static ɵfac: i0.ɵɵFactoryDeclaration<ExecutionsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<ExecutionsService>;
}