@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
108 lines (107 loc) • 8.81 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { PagedResourceListOfStagedModification } from '../model/pagedResourceListOfStagedModification';
import { PagedResourceListOfStagedModificationsRequestedChangeInterval } from '../model/pagedResourceListOfStagedModificationsRequestedChangeInterval';
import { StagedModification } from '../model/stagedModification';
import { StagedModificationDecisionRequest } from '../model/stagedModificationDecisionRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class StagedModificationsService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* [EXPERIMENTAL] AddDecision: AddDecision
* Add decision to staged modification, Approve or Reject.
* @param id Unique Id for a staged modification..
* @param stagedModificationDecisionRequest The decision on the requested staged modification, \"Approve\" or \"Reject\".
* @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.
*/
addDecision(id: string, stagedModificationDecisionRequest: StagedModificationDecisionRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<StagedModification>;
addDecision(id: string, stagedModificationDecisionRequest: StagedModificationDecisionRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<StagedModification>>;
addDecision(id: string, stagedModificationDecisionRequest: StagedModificationDecisionRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<StagedModification>>;
/**
* [EXPERIMENTAL] GetStagedModification: GetStagedModification
* Retrieve the details of a staged modification.
* @param id The unique identifier for a staged modification.
* @param asAt The asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified.
* @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.
*/
getStagedModification(id: string, asAt?: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<StagedModification>;
getStagedModification(id: string, asAt?: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<StagedModification>>;
getStagedModification(id: string, asAt?: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<StagedModification>>;
/**
* [EXPERIMENTAL] ListRequestedChanges: ListRequestedChanges
* List the requested changes for a staged modification.
* @param id Unique Id for a staged modification..
* @param asAt The asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified.
* @param page The pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.
* @param limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
* @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 sortBy A list of field names suffixed by \" ASC\" or \" DESC\"
* @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.
*/
listRequestedChanges(id: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfStagedModificationsRequestedChangeInterval>;
listRequestedChanges(id: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfStagedModificationsRequestedChangeInterval>>;
listRequestedChanges(id: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfStagedModificationsRequestedChangeInterval>>;
/**
* [EXPERIMENTAL] ListStagedModifications: ListStagedModifications
* List summaries of the staged modifications.
* @param asAt The asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified.
* @param page The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.
* @param limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
* @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 sortBy A list of field names suffixed by \" ASC\" or \" DESC\"
* @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.
*/
listStagedModifications(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfStagedModification>;
listStagedModifications(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfStagedModification>>;
listStagedModifications(asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfStagedModification>>;
static ɵfac: i0.ɵɵFactoryDeclaration<StagedModificationsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<StagedModificationsService>;
}