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

Inheritance diagram for Lusid.Sdk.Api.OrderManagementApi:

[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?), int operationIndex=0)
	[EXPERIMENTAL] 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< BookTransactionsResponse >	BookTransactionsWithHttpInfo (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), int operationIndex=0)
	[EXPERIMENTAL] 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< BookTransactionsResponse >	BookTransactionsAsync (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] 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?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] 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...

ResourceListOfBlockAndOrders	CreateOrders (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0)
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfBlockAndOrders >	CreateOrdersWithHttpInfo (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0)
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. More...

async System.Threading.Tasks.Task< ResourceListOfBlockAndOrders >	CreateOrdersAsync (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. 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< ResourceListOfBlockAndOrders > >	CreateOrdersWithHttpInfoAsync (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request. More...

ResourceListOfMovedOrderToDifferentBlockResponse	MoveOrders (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0)
	[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< ResourceListOfMovedOrderToDifferentBlockResponse >	MoveOrdersWithHttpInfo (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0)
	[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< ResourceListOfMovedOrderToDifferentBlockResponse >	MoveOrdersAsync (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[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))
	[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)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block's existence will be verified. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPlacement >	PlaceBlocksWithHttpInfo (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block's existence will be verified. More...

async System.Threading.Tasks.Task< ResourceListOfPlacement >	PlaceBlocksAsync (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block'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))
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. The referenced block's existence will be verified. More...

AllocationServiceRunResponse	RunAllocationService (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0)
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders. More...

Lusid.Sdk.Client.ApiResponse< AllocationServiceRunResponse >	RunAllocationServiceWithHttpInfo (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0)
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders. More...

async System.Threading.Tasks.Task< AllocationServiceRunResponse >	RunAllocationServiceAsync (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders. 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))
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders. 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...

Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

configuration An 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

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ BookTransactions()

BookTransactionsResponse Lusid.Sdk.Api.OrderManagementApi.BookTransactions	(	BookTransactionsRequest	bookTransactionsRequest,
		bool?	applyFeesAndCommission = `default(bool?)`,
		int	operationIndex = `0`
	)

inline

[EXPERIMENTAL] 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.ApiException Thrown when fails to make API call

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
operationIndex	Index associated with the operation.

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?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EXPERIMENTAL] 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.ApiException Thrown when fails to make API call

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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?)`,
		int	operationIndex = `0`
	)

inline

[EXPERIMENTAL] 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.ApiException Thrown when fails to make API call

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
operationIndex	Index associated with the operation.

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?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EXPERIMENTAL] 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.ApiException Thrown when fails to make API call

Parameters

bookTransactionsRequest	The allocations to create transactions for
applyFeesAndCommission	Whether to apply fees and commissions to transactions (default: true) (optional, default to true)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (BookTransactionsResponse)

Implements Lusid.Sdk.Api.IOrderManagementApiAsync.

◆ CreateOrders()

ResourceListOfBlockAndOrders Lusid.Sdk.Api.OrderManagementApi.CreateOrders	(	BlockAndOrdersCreateRequest	blockAndOrdersCreateRequest,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.

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)`
	)

inline

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

inline

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.

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)`
	)

inline

[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders Upsert a Block and create associated orders. This will fail if the block exists and already references orders with differing fields to the upsert request.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

blockAndOrdersCreateRequest	The collection of block and orders requests.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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

Implements Lusid.Sdk.Client.IApiAccessor.

◆ MoveOrders()

ResourceListOfMovedOrderToDifferentBlockResponse Lusid.Sdk.Api.OrderManagementApi.MoveOrders	(	MoveOrdersToDifferentBlocksRequest	moveOrdersToDifferentBlocksRequest,
		int	operationIndex = `0`
	)

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.ApiException Thrown when fails to make API call

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.

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)`
	)

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.ApiException Thrown when fails to make API call

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

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.ApiException Thrown when fails to make API call

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.

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)`
	)

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.ApiException Thrown when fails to make API call

Parameters

moveOrdersToDifferentBlocksRequest	The collection of order and destination block ids.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.

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)`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.

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)`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

placeBlocksRequest	The request containing the blocks to the placed. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

inline

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

resourceId	The List of Placement IDs for which you wish to allocate executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.

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)`
	)

inline

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

resourceId	The List of Placement IDs for which you wish to allocate executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the 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`
	)

inline

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

resourceId	The List of Placement IDs for which you wish to allocate executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.

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)`
	)

inline

[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service This will allocate executions for a given list of placements back to their originating orders.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

resourceId	The List of Placement IDs for which you wish to allocate executions.
allocationAlgorithm	A string representation of the allocation algorithm you would like to use to allocate shares from executions e.g. "PR-FIFO". This defaults to "PR-FIFO". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AllocationServiceRunResponse)

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:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/OrderManagementApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ OrderManagementApi() [1/4]

◆ OrderManagementApi() [2/4]

◆ OrderManagementApi() [3/4]

◆ OrderManagementApi() [4/4]

Member Function Documentation

◆ BookTransactions()

◆ BookTransactionsAsync()

◆ BookTransactionsWithHttpInfo()

◆ BookTransactionsWithHttpInfoAsync()

◆ CreateOrders()

◆ CreateOrdersAsync()

◆ CreateOrdersWithHttpInfo()

◆ CreateOrdersWithHttpInfoAsync()

◆ GetBasePath()

◆ MoveOrders()

◆ MoveOrdersAsync()

◆ MoveOrdersWithHttpInfo()

◆ MoveOrdersWithHttpInfoAsync()

◆ PlaceBlocks()

◆ PlaceBlocksAsync()

◆ PlaceBlocksWithHttpInfo()

◆ PlaceBlocksWithHttpInfoAsync()

◆ RunAllocationService()

◆ RunAllocationServiceAsync()

◆ RunAllocationServiceWithHttpInfo()

◆ RunAllocationServiceWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory