LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.OrderManagementApi Class Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.OrderManagementApi:
Inheritance graph
[legend]

Public Member Functions

 OrderManagementApi ()
 Initializes a new instance of the OrderManagementApi class. More...
 
 OrderManagementApi (string basePath)
 Initializes a new instance of the OrderManagementApi class. More...
 
 OrderManagementApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the OrderManagementApi class using Configuration object More...
 
 OrderManagementApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the OrderManagementApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
BookTransactionsResponse BookTransactions (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
 BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. More...
 
Lusid.Sdk.Client.ApiResponse< BookTransactionsResponseBookTransactionsWithHttpInfo (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
 BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. More...
 
async System.Threading.Tasks.Task< BookTransactionsResponseBookTransactionsAsync (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< BookTransactionsResponse > > BookTransactionsWithHttpInfoAsync (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), bool? markOrdersAndAllocationsAsBooked=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions. More...
 
CancelOrdersResponse CancelOrders (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
Lusid.Sdk.Client.ApiResponse< CancelOrdersResponseCancelOrdersWithHttpInfo (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< CancelOrdersResponseCancelOrdersAsync (Dictionary< string, ResourceId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CancelOrdersResponse > > CancelOrdersWithHttpInfoAsync (Dictionary< string, ResourceId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
CancelOrdersAndMoveRemainingResponse CancelOrdersAndMoveRemaining (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. More...
 
Lusid.Sdk.Client.ApiResponse< CancelOrdersAndMoveRemainingResponseCancelOrdersAndMoveRemainingWithHttpInfo (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. More...
 
async System.Threading.Tasks.Task< CancelOrdersAndMoveRemainingResponseCancelOrdersAndMoveRemainingAsync (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CancelOrdersAndMoveRemainingResponse > > CancelOrdersAndMoveRemainingWithHttpInfoAsync (Dictionary< string, CancelOrdersAndMoveRemainingRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis. More...
 
CancelPlacementsResponse CancelPlacements (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
Lusid.Sdk.Client.ApiResponse< CancelPlacementsResponseCancelPlacementsWithHttpInfo (Dictionary< string, ResourceId > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< CancelPlacementsResponseCancelPlacementsAsync (Dictionary< string, ResourceId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< CancelPlacementsResponse > > CancelPlacementsWithHttpInfoAsync (Dictionary< string, ResourceId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
ResourceListOfBlockAndOrders CreateOrders (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfBlockAndOrdersCreateOrdersWithHttpInfo (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields. More...
 
async System.Threading.Tasks.Task< ResourceListOfBlockAndOrdersCreateOrdersAsync (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfBlockAndOrders > > CreateOrdersWithHttpInfoAsync (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields. More...
 
ResourceListOfChangeIntervalWithOrderManagementDetail GetOrderHistory (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeIntervalWithOrderManagementDetailGetOrderHistoryWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities. More...
 
async System.Threading.Tasks.Task< ResourceListOfChangeIntervalWithOrderManagementDetailGetOrderHistoryAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeIntervalWithOrderManagementDetail > > GetOrderHistoryWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities. More...
 
ResourceListOfMovedOrderToDifferentBlockResponse MoveOrders (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfMovedOrderToDifferentBlockResponseMoveOrdersWithHttpInfo (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. More...
 
async System.Threading.Tasks.Task< ResourceListOfMovedOrderToDifferentBlockResponseMoveOrdersAsync (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfMovedOrderToDifferentBlockResponse > > MoveOrdersWithHttpInfoAsync (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request. More...
 
ResourceListOfPlacement PlaceBlocks (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacementPlaceBlocksWithHttpInfo (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified. More...
 
async System.Threading.Tasks.Task< ResourceListOfPlacementPlaceBlocksAsync (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacement > > PlaceBlocksWithHttpInfoAsync (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified. More...
 
AllocationServiceRunResponse RunAllocationService (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results. More...
 
Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponseRunAllocationServiceWithHttpInfo (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results. More...
 
async System.Threading.Tasks.Task< AllocationServiceRunResponseRunAllocationServiceAsync (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponse > > RunAllocationServiceWithHttpInfoAsync (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results. More...
 
AllocationServiceRunResponse RunAllocationServiceWithWeights (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100. More...
 
Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponseRunAllocationServiceWithWeightsWithHttpInfo (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100. More...
 
async System.Threading.Tasks.Task< AllocationServiceRunResponseRunAllocationServiceWithWeightsAsync (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponse > > RunAllocationServiceWithWeightsWithHttpInfoAsync (WeightedAllocationServiceRunRequest weightedAllocationServiceRunRequest, string? allocationAlgorithm=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100. More...
 
SweepBlocksResponse SweepBlocks (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list> More...
 
Lusid.Sdk.Client.ApiResponse< SweepBlocksResponseSweepBlocksWithHttpInfo (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list> More...
 
async System.Threading.Tasks.Task< SweepBlocksResponseSweepBlocksAsync (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list> More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< SweepBlocksResponse > > SweepBlocksWithHttpInfoAsync (SweepBlocksRequest sweepBlocksRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list> More...
 
UpdateOrdersResponse UpdateOrders (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
Lusid.Sdk.Client.ApiResponse< UpdateOrdersResponseUpdateOrdersWithHttpInfo (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< UpdateOrdersResponseUpdateOrdersAsync (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpdateOrdersResponse > > UpdateOrdersWithHttpInfoAsync (Dictionary< string, OrderUpdateRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
UpdatePlacementsResponse UpdatePlacements (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
Lusid.Sdk.Client.ApiResponse< UpdatePlacementsResponseUpdatePlacementsWithHttpInfo (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< UpdatePlacementsResponseUpdatePlacementsAsync (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpdatePlacementsResponse > > UpdatePlacementsWithHttpInfoAsync (Dictionary< string, PlacementUpdateRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ OrderManagementApi() [1/4]

Lusid.Sdk.Api.OrderManagementApi.OrderManagementApi ( )
inline

Initializes a new instance of the OrderManagementApi class.

Returns

◆ OrderManagementApi() [2/4]

Lusid.Sdk.Api.OrderManagementApi.OrderManagementApi ( string  basePath)
inline

Initializes a new instance of the OrderManagementApi class.

Returns

◆ OrderManagementApi() [3/4]

Lusid.Sdk.Api.OrderManagementApi.OrderManagementApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the OrderManagementApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ OrderManagementApi() [4/4]

Lusid.Sdk.Api.OrderManagementApi.OrderManagementApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the OrderManagementApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ BookTransactions()

BookTransactionsResponse Lusid.Sdk.Api.OrderManagementApi.BookTransactions ( BookTransactionsRequest  bookTransactionsRequest,
bool?  applyFeesAndCommission = default(bool?),
bool?  markOrdersAndAllocationsAsBooked = default(bool?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
bookTransactionsRequestThe allocations to create transactions for
applyFeesAndCommissionWhether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBookedWhether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
BookTransactionsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ BookTransactionsAsync()

async System.Threading.Tasks.Task<BookTransactionsResponse> Lusid.Sdk.Api.OrderManagementApi.BookTransactionsAsync ( BookTransactionsRequest  bookTransactionsRequest,
bool?  applyFeesAndCommission = default(bool?),
bool?  markOrdersAndAllocationsAsBooked = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
bookTransactionsRequestThe allocations to create transactions for
applyFeesAndCommissionWhether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBookedWhether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of BookTransactionsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ BookTransactionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BookTransactionsResponse> Lusid.Sdk.Api.OrderManagementApi.BookTransactionsWithHttpInfo ( BookTransactionsRequest  bookTransactionsRequest,
bool?  applyFeesAndCommission = default(bool?),
bool?  markOrdersAndAllocationsAsBooked = default(bool?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
bookTransactionsRequestThe allocations to create transactions for
applyFeesAndCommissionWhether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBookedWhether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of BookTransactionsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ BookTransactionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BookTransactionsResponse> > Lusid.Sdk.Api.OrderManagementApi.BookTransactionsWithHttpInfoAsync ( BookTransactionsRequest  bookTransactionsRequest,
bool?  applyFeesAndCommission = default(bool?),
bool?  markOrdersAndAllocationsAsBooked = default(bool?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

BookTransactions: Books transactions using specific allocations as a source. Takes a collection of allocation IDs, and maps fields from those allocations and related orders onto new transactions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
bookTransactionsRequestThe allocations to create transactions for
applyFeesAndCommissionWhether to apply fees and commissions to transactions (default: true) (optional, default to true)
markOrdersAndAllocationsAsBookedWhether to mark allocations and fully-booked orders with state Booked (optional, default to false)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (BookTransactionsResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelOrders()

CancelOrdersResponse Lusid.Sdk.Api.OrderManagementApi.CancelOrders ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the orders to be cancelled.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CancelOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelOrdersAndMoveRemaining()

CancelOrdersAndMoveRemainingResponse Lusid.Sdk.Api.OrderManagementApi.CancelOrdersAndMoveRemaining ( Dictionary< string, CancelOrdersAndMoveRemainingRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CancelOrdersAndMoveRemainingResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelOrdersAndMoveRemainingAsync()

async System.Threading.Tasks.Task<CancelOrdersAndMoveRemainingResponse> Lusid.Sdk.Api.OrderManagementApi.CancelOrdersAndMoveRemainingAsync ( Dictionary< string, CancelOrdersAndMoveRemainingRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CancelOrdersAndMoveRemainingResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelOrdersAndMoveRemainingWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelOrdersAndMoveRemainingResponse> Lusid.Sdk.Api.OrderManagementApi.CancelOrdersAndMoveRemainingWithHttpInfo ( Dictionary< string, CancelOrdersAndMoveRemainingRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CancelOrdersAndMoveRemainingResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelOrdersAndMoveRemainingWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CancelOrdersAndMoveRemainingResponse> > Lusid.Sdk.Api.OrderManagementApi.CancelOrdersAndMoveRemainingWithHttpInfoAsync ( Dictionary< string, CancelOrdersAndMoveRemainingRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrdersAndMoveRemaining: Cancel existing orders and move any unplaced quantities to new orders in new blocks Cancels existing orders, reducing their quantities to those aleady placed. Any remaining quantities are moved to new orders in new blocks. The placed quantities are distributed to the cancelled orders on a pro-rata basis.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be cancelled, and the destinations of remaining quantities.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CancelOrdersAndMoveRemainingResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelOrdersAsync()

async System.Threading.Tasks.Task<CancelOrdersResponse> Lusid.Sdk.Api.OrderManagementApi.CancelOrdersAsync ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the orders to be cancelled.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CancelOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelOrdersResponse> Lusid.Sdk.Api.OrderManagementApi.CancelOrdersWithHttpInfo ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the orders to be cancelled.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CancelOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelOrdersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CancelOrdersResponse> > Lusid.Sdk.Api.OrderManagementApi.CancelOrdersWithHttpInfoAsync ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelOrders: Cancel existing orders The response returns both the collection of successfully canceled orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the orders to be cancelled.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CancelOrdersResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelPlacements()

CancelPlacementsResponse Lusid.Sdk.Api.OrderManagementApi.CancelPlacements ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the placements to be cancelled.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
CancelPlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelPlacementsAsync()

async System.Threading.Tasks.Task<CancelPlacementsResponse> Lusid.Sdk.Api.OrderManagementApi.CancelPlacementsAsync ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the placements to be cancelled.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of CancelPlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CancelPlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CancelPlacementsResponse> Lusid.Sdk.Api.OrderManagementApi.CancelPlacementsWithHttpInfo ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the placements to be cancelled.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of CancelPlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CancelPlacementsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CancelPlacementsResponse> > Lusid.Sdk.Api.OrderManagementApi.CancelPlacementsWithHttpInfoAsync ( Dictionary< string, ResourceId requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] CancelPlacements: Cancel existing placements The response returns both the collection of successfully canceled placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the ids of the placements to be cancelled.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (CancelPlacementsResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CreateOrders()

ResourceListOfBlockAndOrders Lusid.Sdk.Api.OrderManagementApi.CreateOrders ( BlockAndOrdersCreateRequest  blockAndOrdersCreateRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
blockAndOrdersCreateRequestThe collection of block and orders requests.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfBlockAndOrders

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CreateOrdersAsync()

async System.Threading.Tasks.Task<ResourceListOfBlockAndOrders> Lusid.Sdk.Api.OrderManagementApi.CreateOrdersAsync ( BlockAndOrdersCreateRequest  blockAndOrdersCreateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
blockAndOrdersCreateRequestThe collection of block and orders requests.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfBlockAndOrders

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CreateOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfBlockAndOrders> Lusid.Sdk.Api.OrderManagementApi.CreateOrdersWithHttpInfo ( BlockAndOrdersCreateRequest  blockAndOrdersCreateRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
blockAndOrdersCreateRequestThe collection of block and orders requests.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfBlockAndOrders

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ CreateOrdersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfBlockAndOrders> > Lusid.Sdk.Api.OrderManagementApi.CreateOrdersWithHttpInfoAsync ( BlockAndOrdersCreateRequest  blockAndOrdersCreateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

CreateOrders: Upsert a Block and associated orders Create orders, and blocks if they don&#39;t already exist. This will fail if the block exists and already references orders with differing blocking fields.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
blockAndOrdersCreateRequestThe collection of block and orders requests.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfBlockAndOrders)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.OrderManagementApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

◆ GetOrderHistory()

ResourceListOfChangeIntervalWithOrderManagementDetail Lusid.Sdk.Api.OrderManagementApi.GetOrderHistory ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the order.
codeThe code of the order.
asAtThe asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfChangeIntervalWithOrderManagementDetail

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ GetOrderHistoryAsync()

async System.Threading.Tasks.Task<ResourceListOfChangeIntervalWithOrderManagementDetail> Lusid.Sdk.Api.OrderManagementApi.GetOrderHistoryAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the order.
codeThe code of the order.
asAtThe asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfChangeIntervalWithOrderManagementDetail

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ GetOrderHistoryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeIntervalWithOrderManagementDetail> Lusid.Sdk.Api.OrderManagementApi.GetOrderHistoryWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the order.
codeThe code of the order.
asAtThe asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfChangeIntervalWithOrderManagementDetail

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ GetOrderHistoryWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChangeIntervalWithOrderManagementDetail> > Lusid.Sdk.Api.OrderManagementApi.GetOrderHistoryWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

GetOrderHistory: Get the history of an order and related entity changes Get the changes that have happened to an order and related entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the order.
codeThe code of the order.
asAtThe asAt datetime at which to retrieve the history of the order and related entities. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfChangeIntervalWithOrderManagementDetail)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ MoveOrders()

ResourceListOfMovedOrderToDifferentBlockResponse Lusid.Sdk.Api.OrderManagementApi.MoveOrders ( MoveOrdersToDifferentBlocksRequest  moveOrdersToDifferentBlocksRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
moveOrdersToDifferentBlocksRequestThe collection of order and destination block ids.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfMovedOrderToDifferentBlockResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ MoveOrdersAsync()

async System.Threading.Tasks.Task<ResourceListOfMovedOrderToDifferentBlockResponse> Lusid.Sdk.Api.OrderManagementApi.MoveOrdersAsync ( MoveOrdersToDifferentBlocksRequest  moveOrdersToDifferentBlocksRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
moveOrdersToDifferentBlocksRequestThe collection of order and destination block ids.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfMovedOrderToDifferentBlockResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ MoveOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfMovedOrderToDifferentBlockResponse> Lusid.Sdk.Api.OrderManagementApi.MoveOrdersWithHttpInfo ( MoveOrdersToDifferentBlocksRequest  moveOrdersToDifferentBlocksRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
moveOrdersToDifferentBlocksRequestThe collection of order and destination block ids.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfMovedOrderToDifferentBlockResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ MoveOrdersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfMovedOrderToDifferentBlockResponse> > Lusid.Sdk.Api.OrderManagementApi.MoveOrdersWithHttpInfoAsync ( MoveOrdersToDifferentBlocksRequest  moveOrdersToDifferentBlocksRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] MoveOrders: Move orders to new or existing block Move an order to a block, creating the block if it does not already exist. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
moveOrdersToDifferentBlocksRequestThe collection of order and destination block ids.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfMovedOrderToDifferentBlockResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ PlaceBlocks()

ResourceListOfPlacement Lusid.Sdk.Api.OrderManagementApi.PlaceBlocks ( PlaceBlocksRequest placeBlocksRequest = default(PlaceBlocksRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
placeBlocksRequestThe request containing the blocks to the placed. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfPlacement

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ PlaceBlocksAsync()

async System.Threading.Tasks.Task<ResourceListOfPlacement> Lusid.Sdk.Api.OrderManagementApi.PlaceBlocksAsync ( PlaceBlocksRequest placeBlocksRequest = default(PlaceBlocksRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
placeBlocksRequestThe request containing the blocks to the placed. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfPlacement

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ PlaceBlocksWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPlacement> Lusid.Sdk.Api.OrderManagementApi.PlaceBlocksWithHttpInfo ( PlaceBlocksRequest placeBlocksRequest = default(PlaceBlocksRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
placeBlocksRequestThe request containing the blocks to the placed. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfPlacement

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ PlaceBlocksWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPlacement> > Lusid.Sdk.Api.OrderManagementApi.PlaceBlocksWithHttpInfoAsync ( PlaceBlocksRequest placeBlocksRequest = default(PlaceBlocksRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block&#39;s existence will be verified.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
placeBlocksRequestThe request containing the blocks to the placed. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfPlacement)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ RunAllocationService()

AllocationServiceRunResponse Lusid.Sdk.Api.OrderManagementApi.RunAllocationService ( List< ResourceId resourceId,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
resourceIdThe List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-FIFO&quot;. This defaults to &quot;PR-FIFO&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ RunAllocationServiceAsync()

async System.Threading.Tasks.Task<AllocationServiceRunResponse> Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceAsync ( List< ResourceId resourceId,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
resourceIdThe List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-FIFO&quot;. This defaults to &quot;PR-FIFO&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ RunAllocationServiceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithHttpInfo ( List< ResourceId resourceId,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
resourceIdThe List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-FIFO&quot;. This defaults to &quot;PR-FIFO&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ RunAllocationServiceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> > Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithHttpInfoAsync ( List< ResourceId resourceId,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

RunAllocationService: Runs the Allocation Service Allocates Executions for a given list of placements back to their originating orders using one of the LUSID algorithms, creating Allocations to record the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
resourceIdThe List of Placement IDs for which you wish to allocate Executions.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-FIFO&quot;. This defaults to &quot;PR-FIFO&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (AllocationServiceRunResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ RunAllocationServiceWithWeights()

AllocationServiceRunResponse Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithWeights ( WeightedAllocationServiceRunRequest  weightedAllocationServiceRunRequest,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
weightedAllocationServiceRunRequestThe placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-LF&quot;. Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to &quot;PR-LF&quot;. Valid values are &quot;PR-LF&quot;, &quot;PR-SF&quot;, &quot;LF&quot;, &quot;SF&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ RunAllocationServiceWithWeightsAsync()

async System.Threading.Tasks.Task<AllocationServiceRunResponse> Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithWeightsAsync ( WeightedAllocationServiceRunRequest  weightedAllocationServiceRunRequest,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
weightedAllocationServiceRunRequestThe placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-LF&quot;. Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to &quot;PR-LF&quot;. Valid values are &quot;PR-LF&quot;, &quot;PR-SF&quot;, &quot;LF&quot;, &quot;SF&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ RunAllocationServiceWithWeightsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithWeightsWithHttpInfo ( WeightedAllocationServiceRunRequest  weightedAllocationServiceRunRequest,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
weightedAllocationServiceRunRequestThe placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-LF&quot;. Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to &quot;PR-LF&quot;. Valid values are &quot;PR-LF&quot;, &quot;PR-SF&quot;, &quot;LF&quot;, &quot;SF&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of AllocationServiceRunResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ RunAllocationServiceWithWeightsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AllocationServiceRunResponse> > Lusid.Sdk.Api.OrderManagementApi.RunAllocationServiceWithWeightsWithHttpInfoAsync ( WeightedAllocationServiceRunRequest  weightedAllocationServiceRunRequest,
string?  allocationAlgorithm = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] RunAllocationServiceWithWeights: Runs the Allocation Service with portfolio weights Allocates Executions for a given list of placements to a specified set of portfolios by weight, creating Allocations to record the results. Used for the unsolicited Block and Block Trade booking flows where no Orders exist against the Block. Weights are relative to each other and are not required to sum to 1 or 100.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
weightedAllocationServiceRunRequestThe placement IDs to allocate against, and the portfolio weights to use for the allocation split.
allocationAlgorithmA string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. &quot;PR-LF&quot;. Allocating with weights means the base algorithm is always pro-rata, and the orphan allocation algorithm is either Largest First or Smallest First. This defaults to &quot;PR-LF&quot;. Valid values are &quot;PR-LF&quot;, &quot;PR-SF&quot;, &quot;LF&quot;, &quot;SF&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (AllocationServiceRunResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ SweepBlocks()

SweepBlocksResponse Lusid.Sdk.Api.OrderManagementApi.SweepBlocks ( SweepBlocksRequest  sweepBlocksRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sweepBlocksRequest
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
SweepBlocksResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ SweepBlocksAsync()

async System.Threading.Tasks.Task<SweepBlocksResponse> Lusid.Sdk.Api.OrderManagementApi.SweepBlocksAsync ( SweepBlocksRequest  sweepBlocksRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sweepBlocksRequest
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of SweepBlocksResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ SweepBlocksWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<SweepBlocksResponse> Lusid.Sdk.Api.OrderManagementApi.SweepBlocksWithHttpInfo ( SweepBlocksRequest  sweepBlocksRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sweepBlocksRequest
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of SweepBlocksResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ SweepBlocksWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<SweepBlocksResponse> > Lusid.Sdk.Api.OrderManagementApi.SweepBlocksWithHttpInfoAsync ( SweepBlocksRequest  sweepBlocksRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] SweepBlocks: Sweeps specified blocks, for each block that meets the requirements. The request may be partially successful. The requirements are: <list type&#x3D;&quot;bullet&quot;><term>The block exists.</term><term>All orders have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>All placements have state &quot;Allocated&quot; or &quot;Over-allocated&quot;.</term><term>All allocations have state &quot;Closed&quot;, &quot;Cancelled&quot;, &quot;Canceled&quot; or &quot;Booked&quot;.</term><term>No execution or allocation has been modified since the passed LatestAllowableModificationTime.</term></list>

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
sweepBlocksRequest
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (SweepBlocksResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ UpdateOrders()

UpdateOrdersResponse Lusid.Sdk.Api.OrderManagementApi.UpdateOrders ( Dictionary< string, OrderUpdateRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be updated.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpdateOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ UpdateOrdersAsync()

async System.Threading.Tasks.Task<UpdateOrdersResponse> Lusid.Sdk.Api.OrderManagementApi.UpdateOrdersAsync ( Dictionary< string, OrderUpdateRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpdateOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ UpdateOrdersWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpdateOrdersResponse> Lusid.Sdk.Api.OrderManagementApi.UpdateOrdersWithHttpInfo ( Dictionary< string, OrderUpdateRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be updated.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpdateOrdersResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ UpdateOrdersWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpdateOrdersResponse> > Lusid.Sdk.Api.OrderManagementApi.UpdateOrdersWithHttpInfoAsync ( Dictionary< string, OrderUpdateRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdateOrders: Update existing orders The response returns both the collection of successfully updated orders, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the orders to be updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpdateOrdersResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ UpdatePlacements()

UpdatePlacementsResponse Lusid.Sdk.Api.OrderManagementApi.UpdatePlacements ( Dictionary< string, PlacementUpdateRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the placements to be updated.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
UpdatePlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ UpdatePlacementsAsync()

async System.Threading.Tasks.Task<UpdatePlacementsResponse> Lusid.Sdk.Api.OrderManagementApi.UpdatePlacementsAsync ( Dictionary< string, PlacementUpdateRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the placements to be updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of UpdatePlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ UpdatePlacementsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpdatePlacementsResponse> Lusid.Sdk.Api.OrderManagementApi.UpdatePlacementsWithHttpInfo ( Dictionary< string, PlacementUpdateRequest requestBody,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the placements to be updated.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of UpdatePlacementsResponse

Implements Lusid.Sdk.Api.IOrderManagementApiSync.

◆ UpdatePlacementsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpdatePlacementsResponse> > Lusid.Sdk.Api.OrderManagementApi.UpdatePlacementsWithHttpInfoAsync ( Dictionary< string, PlacementUpdateRequest requestBody,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpdatePlacements: Update existing placements The response returns both the collection of successfully updated placements, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
requestBodyThe request containing the placements to be updated.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (UpdatePlacementsResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.OrderManagementApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.OrderManagementApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.OrderManagementApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.OrderManagementApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: