@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
107 lines (106 loc) • 8.42 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfPlacement } from '../model/pagedResourceListOfPlacement';
import { Placement } from '../model/placement';
import { PlacementSetRequest } from '../model/placementSetRequest';
import { ResourceListOfPlacement } from '../model/resourceListOfPlacement';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class PlacementsService {
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] DeletePlacement: Delete placement
* Delete an placement. Deletion will be valid from the placement\'s creation datetime. This means that the placement will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param scope The placement scope.
* @param code The placement\'s code. This, together with the scope uniquely identifies the placement 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.
*/
deletePlacement(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<DeletedEntityResponse>;
deletePlacement(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deletePlacement(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetPlacement: Get Placement
* Fetch a Placement that matches the specified identifier
* @param scope The scope to which the placement belongs.
* @param code The placement\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.
* @param propertyKeys A list of property keys from the \"Placement\" domain to decorate onto the placement. If none are given, all applied properties are returned. These take the format {domain}/{scope}/{code} e.g. \"Placement/system/Name\". Property keys from the instrument domain can also be decorated onto the placement, e.g. \"Instrument/default/Isin\". These are only decorated if requested.
* @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.
*/
getPlacement(scope: string, code: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<Placement>;
getPlacement(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<Placement>>;
getPlacement(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<Placement>>;
/**
* [EARLY ACCESS] ListPlacements: List Placements
* Fetch the last pre-AsAt date version of each placement in scope (does not fetch the entire history).
* @param asAt The asAt datetime at which to retrieve the placement. Defaults to return the latest version of the placement if not specified.
* @param page The pagination token to use to continue listing placements from a previous call to list placements. 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 \"Placement\" domain to decorate onto each placement. These take the format {domain}/{scope}/{code} e.g. \"Placement/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.
*/
listPlacements(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<PagedResourceListOfPlacement>;
listPlacements(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<PagedResourceListOfPlacement>>;
listPlacements(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<PagedResourceListOfPlacement>>;
/**
* [EARLY ACCESS] UpsertPlacements: Upsert Placement
* Upsert; update existing placements with given ids, or create new placements otherwise.
* @param placementSetRequest The collection of placement 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.
*/
upsertPlacements(placementSetRequest?: PlacementSetRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<ResourceListOfPlacement>;
upsertPlacements(placementSetRequest?: PlacementSetRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<ResourceListOfPlacement>>;
upsertPlacements(placementSetRequest?: PlacementSetRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<ResourceListOfPlacement>>;
static ɵfac: i0.ɵɵFactoryDeclaration<PlacementsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<PlacementsService>;
}