@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
107 lines (106 loc) • 8.23 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { Allocation } from '../model/allocation';
import { AllocationSetRequest } from '../model/allocationSetRequest';
import { DeletedEntityResponse } from '../model/deletedEntityResponse';
import { PagedResourceListOfAllocation } from '../model/pagedResourceListOfAllocation';
import { ResourceListOfAllocation } from '../model/resourceListOfAllocation';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class AllocationsService {
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] DeleteAllocation: Delete allocation
* Delete an allocation. Deletion will be valid from the allocation\'s creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.
* @param scope The allocation scope.
* @param code The allocation\'s code. This, together with the scope uniquely identifies the allocation 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.
*/
deleteAllocation(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<DeletedEntityResponse>;
deleteAllocation(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteAllocation(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EARLY ACCESS] GetAllocation: Get Allocation
* Fetch an Allocation matching the provided identifier
* @param scope The scope to which the allocation belongs.
* @param code The allocation\'s unique identifier.
* @param asAt The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
* @param propertyKeys A list of property keys from the \"Allocations\" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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.
*/
getAllocation(scope: string, code: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<Allocation>;
getAllocation(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<Allocation>>;
getAllocation(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<Allocation>>;
/**
* ListAllocations: List Allocations
* Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).
* @param asAt The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified.
* @param page The pagination token to use to continue listing allocations from a previous call to list allocations. 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 \"Allocations\" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. \"Allocations/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.
*/
listAllocations(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<PagedResourceListOfAllocation>;
listAllocations(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<PagedResourceListOfAllocation>>;
listAllocations(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<PagedResourceListOfAllocation>>;
/**
* UpsertAllocations: Upsert Allocations
* Upsert; update existing allocations with given ids, or create new allocations otherwise.
* @param allocationSetRequest The collection of allocation 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.
*/
upsertAllocations(allocationSetRequest?: AllocationSetRequest, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<ResourceListOfAllocation>;
upsertAllocations(allocationSetRequest?: AllocationSetRequest, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<ResourceListOfAllocation>>;
upsertAllocations(allocationSetRequest?: AllocationSetRequest, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<ResourceListOfAllocation>>;
static ɵfac: i0.ɵɵFactoryDeclaration<AllocationsService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<AllocationsService>;
}