@finbourne/lusid-sdk-angular16
Version:
An angular (16) SDK for secure access to the LUSID® by FINBOURNE web API
93 lines (92 loc) • 8.66 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { PagedResourceListOfOrderGraphBlock } from '../model/pagedResourceListOfOrderGraphBlock';
import { PagedResourceListOfOrderGraphPlacement } from '../model/pagedResourceListOfOrderGraphPlacement';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class OrderGraphService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* ListOrderGraphBlocks: Lists blocks that pass the filter provided, and builds a summary picture of the state of their associated order entities.
* Lists all blocks of orders, subject to the filter, along with the IDs of orders, placements, allocations and executions in the block, the total quantities of each, and a simple text field describing the overall state.
* @param asAt See https://support.lusid.com/knowledgebase/article/KA-01832/
* @param paginationToken See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param sortBy A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
* @param limit See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param filter See https://support.lusid.com/knowledgebase/article/KA-01914/
* @param propertyKeys Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
* @param useComplianceV2 Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false)
* @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.
*/
listOrderGraphBlocks(asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, useComplianceV2?: boolean, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfOrderGraphBlock>;
listOrderGraphBlocks(asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, useComplianceV2?: boolean, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfOrderGraphBlock>>;
listOrderGraphBlocks(asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, filter?: string, propertyKeys?: Array<string>, useComplianceV2?: boolean, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfOrderGraphBlock>>;
/**
* [EARLY ACCESS] ListOrderGraphPlacementChildren: Lists all placements for the parent placement specified by the scope and code, and builds a summary picture of the state of their associated order entities.
* Lists all child order placements, for the specified parent placement, along with the IDs of the block and order that the placement is for, each placement\'s quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.
* @param scope The parent placement\'s scope
* @param code The parent placement\'s code
* @param asAt See https://support.lusid.com/knowledgebase/article/KA-01832/
* @param paginationToken See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param sortBy Order the results by these fields. Use use the \'-\' sign to denote descending order e.g. -MyFieldName.
* @param limit See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param propertyKeys Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
* @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.
*/
listOrderGraphPlacementChildren(scope: string, code: string, asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<PagedResourceListOfOrderGraphPlacement>;
listOrderGraphPlacementChildren(scope: string, code: string, asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpResponse<PagedResourceListOfOrderGraphPlacement>>;
listOrderGraphPlacementChildren(scope: string, code: string, asAt?: string, paginationToken?: string, sortBy?: Array<string>, limit?: number, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
}): Observable<HttpEvent<PagedResourceListOfOrderGraphPlacement>>;
/**
* ListOrderGraphPlacements: Lists placements that pass the filter provided, and builds a summary picture of the state of their associated order entities.
* Lists all order placements, subject to the filter, along with the IDs of the block and order that the placement is for, each placement\'s quantity, the IDs of all allocations and executions in the placement and the total quantities of those, and a simple text field describing the overall state of the placement.
* @param asAt See https://support.lusid.com/knowledgebase/article/KA-01832/
* @param paginationToken See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param sortBy A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
* @param limit See https://support.lusid.com/knowledgebase/article/KA-01915/
* @param filter See https://support.lusid.com/knowledgebase/article/KA-01914/
* @param propertyKeys Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/
* @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.
*/
listOrderGraphPlacements(asAt?: string, paginationToken?: 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<PagedResourceListOfOrderGraphPlacement>;
listOrderGraphPlacements(asAt?: string, paginationToken?: 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<PagedResourceListOfOrderGraphPlacement>>;
listOrderGraphPlacements(asAt?: string, paginationToken?: 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<PagedResourceListOfOrderGraphPlacement>>;
static ɵfac: i0.ɵɵFactoryDeclaration<OrderGraphService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<OrderGraphService>;
}