UNPKG

@finbourne/lusid-sdk-angular18

Version:

An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API

131 lines (130 loc) 8.76 kB
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 interface ListOrderGraphBlocksRequestParams { /** See https://support.lusid.com/knowledgebase/article/KA-01832/ */ asAt?: string; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ paginationToken?: string; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */ sortBy?: Array<string>; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ limit?: number; /** See https://support.lusid.com/knowledgebase/article/KA-01914/ */ filter?: string; /** Must be block-level properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ */ propertyKeys?: Array<string>; /** Whether to use the V2 compliance engine when deriving compliance statuses for orders. (default: false) */ useComplianceV2?: boolean; } export interface ListOrderGraphPlacementChildrenRequestParams { /** The parent placement\&#39;s scope */ scope: string; /** The parent placement\&#39;s code */ code: string; /** See https://support.lusid.com/knowledgebase/article/KA-01832/ */ asAt?: string; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ paginationToken?: string; /** Order the results by these fields. Use use the \&#39;-\&#39; sign to denote descending order e.g. -MyFieldName. */ sortBy?: Array<string>; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ limit?: number; /** Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ */ propertyKeys?: Array<string>; } export interface ListOrderGraphPlacementsRequestParams { /** See https://support.lusid.com/knowledgebase/article/KA-01832/ */ asAt?: string; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ paginationToken?: string; /** A list of field names or properties to sort by, each suffixed by \&quot; ASC\&quot; or \&quot; DESC\&quot;. */ sortBy?: Array<string>; /** See https://support.lusid.com/knowledgebase/article/KA-01915/ */ limit?: number; /** See https://support.lusid.com/knowledgebase/article/KA-01914/ */ filter?: string; /** Must be placement properties. See https://support.lusid.com/knowledgebase/article/KA-01855/ */ propertyKeys?: Array<string>; } 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 requestParameters * @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(requestParameters?: ListOrderGraphBlocksRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfOrderGraphBlock>; listOrderGraphBlocks(requestParameters?: ListOrderGraphBlocksRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfOrderGraphBlock>>; listOrderGraphBlocks(requestParameters?: ListOrderGraphBlocksRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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\&#39;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 requestParameters * @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(requestParameters?: ListOrderGraphPlacementChildrenRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfOrderGraphPlacement>; listOrderGraphPlacementChildren(requestParameters?: ListOrderGraphPlacementChildrenRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfOrderGraphPlacement>>; listOrderGraphPlacementChildren(requestParameters?: ListOrderGraphPlacementChildrenRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): 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\&#39;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 requestParameters * @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(requestParameters?: ListOrderGraphPlacementsRequestParams, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<PagedResourceListOfOrderGraphPlacement>; listOrderGraphPlacements(requestParameters?: ListOrderGraphPlacementsRequestParams, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpResponse<PagedResourceListOfOrderGraphPlacement>>; listOrderGraphPlacements(requestParameters?: ListOrderGraphPlacementsRequestParams, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; transferCache?: boolean; }): Observable<HttpEvent<PagedResourceListOfOrderGraphPlacement>>; static ɵfac: i0.ɵɵFactoryDeclaration<OrderGraphService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<OrderGraphService>; }