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

Inheritance diagram for Lusid.Sdk.Api.LegacyComplianceApi:

[legend]

Public Member Functions
	LegacyComplianceApi ()
	Initializes a new instance of the LegacyComplianceApi class. More...

	LegacyComplianceApi (string basePath)
	Initializes a new instance of the LegacyComplianceApi class. More...

	LegacyComplianceApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the LegacyComplianceApi class using Configuration object More...

	LegacyComplianceApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the LegacyComplianceApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

DeletedEntityResponse	DeleteLegacyComplianceRule (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteLegacyComplianceRuleWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteLegacyComplianceRuleAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteLegacyComplianceRuleWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone. More...

ResourceListOfComplianceBreachedOrderInfo	GetLegacyBreachedOrdersInfo (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceBreachedOrderInfo >	GetLegacyBreachedOrdersInfoWithHttpInfo (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach. More...

async System.Threading.Tasks.Task< ResourceListOfComplianceBreachedOrderInfo >	GetLegacyBreachedOrdersInfoAsync (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceBreachedOrderInfo > >	GetLegacyBreachedOrdersInfoWithHttpInfoAsync (string runId, string? orderScope=default(string?), string? orderCode=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach. More...

ComplianceRule	GetLegacyComplianceRule (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRule >	GetLegacyComplianceRuleWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times. More...

async System.Threading.Tasks.Task< ComplianceRule >	GetLegacyComplianceRuleAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ComplianceRule > >	GetLegacyComplianceRuleWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times. More...

ResourceListOfComplianceRuleResult	GetLegacyComplianceRunResults (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRuleResult >	GetLegacyComplianceRunResultsWithHttpInfo (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination. More...

async System.Threading.Tasks.Task< ResourceListOfComplianceRuleResult >	GetLegacyComplianceRunResultsAsync (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRuleResult > >	GetLegacyComplianceRunResultsWithHttpInfoAsync (string runId, string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination. More...

ResourceListOfComplianceRule	ListLegacyComplianceRules (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRule >	ListLegacyComplianceRulesWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. More...

async System.Threading.Tasks.Task< ResourceListOfComplianceRule >	ListLegacyComplianceRulesAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRule > >	ListLegacyComplianceRulesWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. More...

ResourceListOfComplianceRunInfo	ListLegacyComplianceRunInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRunInfo >	ListLegacyComplianceRunInfoWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs. More...

async System.Threading.Tasks.Task< ResourceListOfComplianceRunInfo >	ListLegacyComplianceRunInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfComplianceRunInfo > >	ListLegacyComplianceRunInfoWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs. More...

ComplianceRunInfo	RunLegacyCompliance (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRunInfo >	RunLegacyComplianceWithHttpInfo (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file. More...

async System.Threading.Tasks.Task< ComplianceRunInfo >	RunLegacyComplianceAsync (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ComplianceRunInfo > >	RunLegacyComplianceWithHttpInfoAsync (bool isPreTrade, string recipeIdScope, string? recipeIdCode=default(string?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file. More...

ComplianceRuleUpsertResponse	UpsertLegacyComplianceRules (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleUpsertResponse >	UpsertLegacyComplianceRulesWithHttpInfo (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. More...

async System.Threading.Tasks.Task< ComplianceRuleUpsertResponse >	UpsertLegacyComplianceRulesAsync (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ComplianceRuleUpsertResponse > >	UpsertLegacyComplianceRulesWithHttpInfoAsync (Dictionary< string, ComplianceRuleUpsertRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. 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

◆ LegacyComplianceApi() [1/4]

Lusid.Sdk.Api.LegacyComplianceApi.LegacyComplianceApi ( )

inline

Initializes a new instance of the LegacyComplianceApi class.

Returns

◆ LegacyComplianceApi() [2/4]

Lusid.Sdk.Api.LegacyComplianceApi.LegacyComplianceApi ( string basePath )

inline

Initializes a new instance of the LegacyComplianceApi class.

Returns

◆ LegacyComplianceApi() [3/4]

Lusid.Sdk.Api.LegacyComplianceApi.LegacyComplianceApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the LegacyComplianceApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ LegacyComplianceApi() [4/4]

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

inline

Initializes a new instance of the LegacyComplianceApi 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

◆ DeleteLegacyComplianceRule()

DeletedEntityResponse Lusid.Sdk.Api.LegacyComplianceApi.DeleteLegacyComplianceRule	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ DeleteLegacyComplianceRuleAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.LegacyComplianceApi.DeleteLegacyComplianceRuleAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ DeleteLegacyComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.LegacyComplianceApi.DeleteLegacyComplianceRuleWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ DeleteLegacyComplianceRuleWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.LegacyComplianceApi.DeleteLegacyComplianceRuleWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteLegacyComplianceRule: Deletes a compliance rule. Deletes the rule for all effective time. The rule will remain viewable at previous as at times, and as part of the results of compliance runs, but it will no longer be considered in new compliance runs. This cannot be undone.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.LegacyComplianceApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetLegacyBreachedOrdersInfo()

ResourceListOfComplianceBreachedOrderInfo Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyBreachedOrdersInfo	(	string	runId,
		string?	orderScope = `default(string?)`,
		string?	orderCode = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions

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

Parameters

runId	The RunId that the results should be checked for
orderScope	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCode	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfComplianceBreachedOrderInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyBreachedOrdersInfoAsync()

async System.Threading.Tasks.Task<ResourceListOfComplianceBreachedOrderInfo> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyBreachedOrdersInfoAsync	(	string	runId,
		string?	orderScope = `default(string?)`,
		string?	orderCode = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions

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

Parameters

runId	The RunId that the results should be checked for
orderScope	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCode	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfComplianceBreachedOrderInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetLegacyBreachedOrdersInfoWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceBreachedOrderInfo> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyBreachedOrdersInfoWithHttpInfo	(	string	runId,
		string?	orderScope = `default(string?)`,
		string?	orderCode = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions

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

Parameters

runId	The RunId that the results should be checked for
orderScope	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCode	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfComplianceBreachedOrderInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyBreachedOrdersInfoWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceBreachedOrderInfo> > Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyBreachedOrdersInfoWithHttpInfoAsync	(	string	runId,
		string?	orderScope = `default(string?)`,
		string?	orderCode = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyBreachedOrdersInfo: Get the Ids of Breached orders in a given compliance run and the corresponding list of rules that could have caused it. Use this endpoint to get a list or breached orders and the set of rules that may have caused the breach.

Exceptions

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

Parameters

runId	The RunId that the results should be checked for
orderScope	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
orderCode	Optional. Find rules related to a specific order by providing an Order Scope/Code combination (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfComplianceBreachedOrderInfo)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetLegacyComplianceRule()

ComplianceRule Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRule	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyComplianceRuleAsync()

async System.Threading.Tasks.Task<ComplianceRule> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRuleAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetLegacyComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRule> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRuleWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyComplianceRuleWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ComplianceRule> > Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRuleWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRule: Retrieve the definition of single compliance rule. Retrieves the compliance rule definition at the given effective and as at times.

Exceptions

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

Parameters

scope	The compliance rule scope.
code	The compliance rule code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ComplianceRule)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetLegacyComplianceRunResults()

ResourceListOfComplianceRuleResult Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRunResults	(	string	runId,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions

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

Parameters

runId	The unique identifier of the compliance run requested.
page	The pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfComplianceRuleResult

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyComplianceRunResultsAsync()

async System.Threading.Tasks.Task<ResourceListOfComplianceRuleResult> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRunResultsAsync	(	string	runId,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions

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

Parameters

runId	The unique identifier of the compliance run requested.
page	The pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfComplianceRuleResult

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ GetLegacyComplianceRunResultsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRuleResult> Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRunResultsWithHttpInfo	(	string	runId,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions

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

Parameters

runId	The unique identifier of the compliance run requested.
page	The pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfComplianceRuleResult

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ GetLegacyComplianceRunResultsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRuleResult> > Lusid.Sdk.Api.LegacyComplianceApi.GetLegacyComplianceRunResultsWithHttpInfoAsync	(	string	runId,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetLegacyComplianceRunResults: Get the details of a single compliance run. Use this endpoint to fetch the detail associated with a specific compliance run, including a breakdown of the passing state of each rule, portfolio combination.

Exceptions

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

Parameters

runId	The unique identifier of the compliance run requested.
page	The pagination token to use to continue listing compliance rule results from a previous call to list compliance rule result. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfComplianceRuleResult)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ ListLegacyComplianceRules()

ResourceListOfComplianceRule Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRules	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ ListLegacyComplianceRulesAsync()

async System.Threading.Tasks.Task<ResourceListOfComplianceRule> Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRulesAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ ListLegacyComplianceRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRule> Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRulesWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfComplianceRule

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ ListLegacyComplianceRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRule> > Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRulesWithHttpInfoAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRules: List compliance rules, with optional filtering. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
page	The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfComplianceRule)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ ListLegacyComplianceRunInfo()

ResourceListOfComplianceRunInfo Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRunInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs.

Exceptions

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

Parameters

asAt	Optional. The time at which to get results from. Default : latest (optional)
page	The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ ListLegacyComplianceRunInfoAsync()

async System.Threading.Tasks.Task<ResourceListOfComplianceRunInfo> Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRunInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs.

Exceptions

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

Parameters

asAt	Optional. The time at which to get results from. Default : latest (optional)
page	The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ ListLegacyComplianceRunInfoWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRunInfo> Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRunInfoWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs.

Exceptions

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

Parameters

asAt	Optional. The time at which to get results from. Default : latest (optional)
page	The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ ListLegacyComplianceRunInfoWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfComplianceRunInfo> > Lusid.Sdk.Api.LegacyComplianceApi.ListLegacyComplianceRunInfoWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListLegacyComplianceRunInfo: List historical compliance run ids. Use this endpoint to fetch a list of all historical compliance runs.

Exceptions

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

Parameters

asAt	Optional. The time at which to get results from. Default : latest (optional)
page	The pagination token to use to continue listing compliance runs from a previous call to list compliance runs. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfComplianceRunInfo)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ RunLegacyCompliance()

ComplianceRunInfo Lusid.Sdk.Api.LegacyComplianceApi.RunLegacyCompliance	(	bool	isPreTrade,
		string	recipeIdScope,
		string?	recipeIdCode = `default(string?)`,
		bool?	byTaxlots = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions

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

Parameters

isPreTrade	Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScope	Required: the scope of the recipe to be used
recipeIdCode	Optional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlots	Optional. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ RunLegacyComplianceAsync()

async System.Threading.Tasks.Task<ComplianceRunInfo> Lusid.Sdk.Api.LegacyComplianceApi.RunLegacyComplianceAsync	(	bool	isPreTrade,
		string	recipeIdScope,
		string?	recipeIdCode = `default(string?)`,
		bool?	byTaxlots = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions

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

Parameters

isPreTrade	Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScope	Required: the scope of the recipe to be used
recipeIdCode	Optional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlots	Optional. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ RunLegacyComplianceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRunInfo> Lusid.Sdk.Api.LegacyComplianceApi.RunLegacyComplianceWithHttpInfo	(	bool	isPreTrade,
		string	recipeIdScope,
		string?	recipeIdCode = `default(string?)`,
		bool?	byTaxlots = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions

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

Parameters

isPreTrade	Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScope	Required: the scope of the recipe to be used
recipeIdCode	Optional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlots	Optional. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRunInfo

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ RunLegacyComplianceWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ComplianceRunInfo> > Lusid.Sdk.Api.LegacyComplianceApi.RunLegacyComplianceWithHttpInfoAsync	(	bool	isPreTrade,
		string	recipeIdScope,
		string?	recipeIdCode = `default(string?)`,
		bool?	byTaxlots = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] RunLegacyCompliance: Kick off the compliance check process Use this endpoint to fetch the start a compliance run, based on a pre-set mapping file.

Exceptions

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

Parameters

isPreTrade	Required: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScope	Required: the scope of the recipe to be used
recipeIdCode	Optional: The code of the recipe to be used. If left blank, the default recipe will be used. (optional)
byTaxlots	Optional. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ComplianceRunInfo)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ UpsertLegacyComplianceRules()

ComplianceRuleUpsertResponse Lusid.Sdk.Api.LegacyComplianceApi.UpsertLegacyComplianceRules	(	Dictionary< string, ComplianceRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRuleUpsertResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ UpsertLegacyComplianceRulesAsync()

async System.Threading.Tasks.Task<ComplianceRuleUpsertResponse> Lusid.Sdk.Api.LegacyComplianceApi.UpsertLegacyComplianceRulesAsync	(	Dictionary< string, ComplianceRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ComplianceRuleUpsertResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

◆ UpsertLegacyComplianceRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleUpsertResponse> Lusid.Sdk.Api.LegacyComplianceApi.UpsertLegacyComplianceRulesWithHttpInfo	(	Dictionary< string, ComplianceRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleUpsertResponse

Implements Lusid.Sdk.Api.ILegacyComplianceApiSync.

◆ UpsertLegacyComplianceRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ComplianceRuleUpsertResponse> > Lusid.Sdk.Api.LegacyComplianceApi.UpsertLegacyComplianceRulesWithHttpInfoAsync	(	Dictionary< string, ComplianceRuleUpsertRequest >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpsertLegacyComplianceRules: Upsert compliance rules. To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the rule code. It is possible to both create and update compliance rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will.

Exceptions

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

Parameters

requestBody	A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted compliance rule to the code of a created compliance rule.
effectiveAt	The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ComplianceRuleUpsertResponse)

Implements Lusid.Sdk.Api.ILegacyComplianceApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.LegacyComplianceApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.LegacyComplianceApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.LegacyComplianceApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.LegacyComplianceApi.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/LegacyComplianceApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LegacyComplianceApi() [1/4]

◆ LegacyComplianceApi() [2/4]

◆ LegacyComplianceApi() [3/4]

◆ LegacyComplianceApi() [4/4]

Member Function Documentation

◆ DeleteLegacyComplianceRule()

◆ DeleteLegacyComplianceRuleAsync()

◆ DeleteLegacyComplianceRuleWithHttpInfo()

◆ DeleteLegacyComplianceRuleWithHttpInfoAsync()

◆ GetBasePath()

◆ GetLegacyBreachedOrdersInfo()

◆ GetLegacyBreachedOrdersInfoAsync()

◆ GetLegacyBreachedOrdersInfoWithHttpInfo()

◆ GetLegacyBreachedOrdersInfoWithHttpInfoAsync()

◆ GetLegacyComplianceRule()

◆ GetLegacyComplianceRuleAsync()

◆ GetLegacyComplianceRuleWithHttpInfo()

◆ GetLegacyComplianceRuleWithHttpInfoAsync()

◆ GetLegacyComplianceRunResults()

◆ GetLegacyComplianceRunResultsAsync()

◆ GetLegacyComplianceRunResultsWithHttpInfo()

◆ GetLegacyComplianceRunResultsWithHttpInfoAsync()

◆ ListLegacyComplianceRules()

◆ ListLegacyComplianceRulesAsync()

◆ ListLegacyComplianceRulesWithHttpInfo()

◆ ListLegacyComplianceRulesWithHttpInfoAsync()

◆ ListLegacyComplianceRunInfo()

◆ ListLegacyComplianceRunInfoAsync()

◆ ListLegacyComplianceRunInfoWithHttpInfo()

◆ ListLegacyComplianceRunInfoWithHttpInfoAsync()

◆ RunLegacyCompliance()

◆ RunLegacyComplianceAsync()

◆ RunLegacyComplianceWithHttpInfo()

◆ RunLegacyComplianceWithHttpInfoAsync()

◆ UpsertLegacyComplianceRules()

◆ UpsertLegacyComplianceRulesAsync()

◆ UpsertLegacyComplianceRulesWithHttpInfo()

◆ UpsertLegacyComplianceRulesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory