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

Inheritance diagram for Lusid.Sdk.Api.IOrderManagementApiSync:

[legend]

Public Member Functions
BookTransactionsResponse	BookTransactions (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), int operationIndex=0)
	[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. More...

ApiResponse< BookTransactionsResponse >	BookTransactionsWithHttpInfo (BookTransactionsRequest bookTransactionsRequest, bool? applyFeesAndCommission=default(bool?), int operationIndex=0)
	[EXPERIMENTAL] BookTransactions: Books transactions using specific allocations as a source. More...

ResourceListOfBlockAndOrders	CreateOrders (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0)
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders More...

ApiResponse< ResourceListOfBlockAndOrders >	CreateOrdersWithHttpInfo (BlockAndOrdersCreateRequest blockAndOrdersCreateRequest, int operationIndex=0)
	[EARLY ACCESS] CreateOrders: Upsert a Block and associated orders More...

ResourceListOfMovedOrderToDifferentBlockResponse	MoveOrders (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0)
	[EARLY ACCESS] MoveOrders: Move orders to new or existing block More...

ApiResponse< ResourceListOfMovedOrderToDifferentBlockResponse >	MoveOrdersWithHttpInfo (MoveOrdersToDifferentBlocksRequest moveOrdersToDifferentBlocksRequest, int operationIndex=0)
	[EARLY ACCESS] MoveOrders: Move orders to new or existing block More...

ResourceListOfPlacement	PlaceBlocks (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. More...

ApiResponse< ResourceListOfPlacement >	PlaceBlocksWithHttpInfo (PlaceBlocksRequest? placeBlocksRequest=default(PlaceBlocksRequest?), int operationIndex=0)
	[EARLY ACCESS] PlaceBlocks: Places blocks for a given list of placement requests. More...

AllocationServiceRunResponse	RunAllocationService (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0)
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service More...

ApiResponse< AllocationServiceRunResponse >	RunAllocationServiceWithHttpInfo (List< ResourceId > resourceId, string? allocationAlgorithm=default(string?), int operationIndex=0)
	[EXPERIMENTAL] RunAllocationService: Runs the Allocation Service More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ BookTransactions()

BookTransactionsResponse Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ BookTransactionsWithHttpInfo()

ApiResponse<BookTransactionsResponse> Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CreateOrders()

ResourceListOfBlockAndOrders Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ CreateOrdersWithHttpInfo()

ApiResponse<ResourceListOfBlockAndOrders> Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ MoveOrders()

ResourceListOfMovedOrderToDifferentBlockResponse Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ MoveOrdersWithHttpInfo()

ApiResponse<ResourceListOfMovedOrderToDifferentBlockResponse> Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ PlaceBlocks()

ResourceListOfPlacement Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ PlaceBlocksWithHttpInfo()

ApiResponse<ResourceListOfPlacement> Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationService()

AllocationServiceRunResponse Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

◆ RunAllocationServiceWithHttpInfo()

ApiResponse<AllocationServiceRunResponse> Lusid.Sdk.Api.IOrderManagementApiSync.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.

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

Implemented in Lusid.Sdk.Api.OrderManagementApi.

The documentation for this interface 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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BookTransactions()

◆ BookTransactionsWithHttpInfo()

◆ CreateOrders()

◆ CreateOrdersWithHttpInfo()

◆ MoveOrders()

◆ MoveOrdersWithHttpInfo()

◆ PlaceBlocks()

◆ PlaceBlocksWithHttpInfo()

◆ RunAllocationService()

◆ RunAllocationServiceWithHttpInfo()