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

Inheritance diagram for Lusid.Sdk.Api.IComplianceApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteComplianceRuleAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteComplianceRuleWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. More...

System.Threading.Tasks.Task< ComplianceRuleResponse >	GetComplianceRuleAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceRule: Get compliance rule. More...

System.Threading.Tasks.Task< ApiResponse< ComplianceRuleResponse > >	GetComplianceRuleWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceRule: Get compliance rule. More...

System.Threading.Tasks.Task< ComplianceRuleResultV2 >	GetComplianceRuleResultAsync (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. More...

System.Threading.Tasks.Task< ApiResponse< ComplianceRuleResultV2 > >	GetComplianceRuleResultWithHttpInfoAsync (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. More...

System.Threading.Tasks.Task< ComplianceTemplate >	GetComplianceTemplateAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. More...

System.Threading.Tasks.Task< ApiResponse< ComplianceTemplate > >	GetComplianceTemplateWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. More...

System.Threading.Tasks.Task< DecoratedComplianceRunSummary >	GetDecoratedComplianceRunSummaryAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. More...

System.Threading.Tasks.Task< ApiResponse< DecoratedComplianceRunSummary > >	GetDecoratedComplianceRunSummaryWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. More...

System.Threading.Tasks.Task< PagedResourceListOfComplianceRuleResponse >	ListComplianceRulesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListComplianceRules: List compliance rules. More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfComplianceRuleResponse > >	ListComplianceRulesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListComplianceRules: List compliance rules. More...

System.Threading.Tasks.Task< PagedResourceListOfComplianceRunInfoV2 >	ListComplianceRunsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfComplianceRunInfoV2 > >	ListComplianceRunsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. More...

System.Threading.Tasks.Task< PagedResourceListOfComplianceTemplate >	ListComplianceTemplatesAsync (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))
	[EARLY ACCESS] ListComplianceTemplates: List compliance templates. More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfComplianceTemplate > >	ListComplianceTemplatesWithHttpInfoAsync (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))
	[EARLY ACCESS] ListComplianceTemplates: List compliance templates. More...

System.Threading.Tasks.Task< ComplianceRunInfoV2 >	RunComplianceAsync (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] RunCompliance: Run a compliance check. More...

System.Threading.Tasks.Task< ApiResponse< ComplianceRunInfoV2 > >	RunComplianceWithHttpInfoAsync (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] RunCompliance: Run a compliance check. More...

System.Threading.Tasks.Task< ComplianceRuleResponse >	UpsertComplianceRuleAsync (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. More...

System.Threading.Tasks.Task< ApiResponse< ComplianceRuleResponse > >	UpsertComplianceRuleWithHttpInfoAsync (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. More...

System.Threading.Tasks.Task< UpsertComplianceRunSummaryResult >	UpsertComplianceRunSummaryAsync (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. More...

System.Threading.Tasks.Task< ApiResponse< UpsertComplianceRunSummaryResult > >	UpsertComplianceRunSummaryWithHttpInfoAsync (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. 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

◆ DeleteComplianceRuleAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IComplianceApiAsync.DeleteComplianceRuleAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule.

Use this endpoint to delete a compliance rule. The rule will be recoverable for asat times earlier than the delete time, but will otherwise appear to have never existed.

Exceptions

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

Parameters

scope	The compliance rule's scope.
code	The compliance rule's code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceRuleWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IComplianceApiAsync.DeleteComplianceRuleWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule.

Use this endpoint to delete a compliance rule. The rule will be recoverable for asat times earlier than the delete time, but will otherwise appear to have never existed.

Exceptions

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

Parameters

scope	The compliance rule's scope.
code	The compliance rule's code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleAsync()

System.Threading.Tasks.Task<ComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceRuleAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceRule: Get compliance rule.

Use this endpoint to retrieve a single compliance rule.

Exceptions

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

Parameters

scope	The compliance rule's scope.
code	The compliance rule's code.
asAt	Optional. Asat time for query. (optional)
propertyKeys	A list of property keys from the 'Compliance' domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example 'Compliance/live/UCITS'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleResultAsync()

System.Threading.Tasks.Task<ComplianceRuleResultV2> Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceRuleResultAsync	(	string	runScope,
		string	runCode,
		string	ruleScope,
		string	ruleCode,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run.

Specify a run scope and code from a previously run compliance check, and the scope and code of a rule within that run, to get detailed results for that rule.

Exceptions

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

Parameters

runScope	Required: Run Scope.
runCode	Required: Run Code.
ruleScope	Required: Rule Scope.
ruleCode	Required: Rule Code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ComplianceRuleResultV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleResultWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRuleResultV2> > Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceRuleResultWithHttpInfoAsync	(	string	runScope,
		string	runCode,
		string	ruleScope,
		string	ruleCode,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run.

Specify a run scope and code from a previously run compliance check, and the scope and code of a rule within that run, to get detailed results for that rule.

Exceptions

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

Parameters

runScope	Required: Run Scope.
runCode	Required: Run Code.
ruleScope	Required: Rule Scope.
ruleCode	Required: Rule Code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ComplianceRuleResultV2)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRuleResponse> > Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceRuleWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceRule: Get compliance rule.

Use this endpoint to retrieve a single compliance rule.

Exceptions

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

Parameters

scope	The compliance rule's scope.
code	The compliance rule's code.
asAt	Optional. Asat time for query. (optional)
propertyKeys	A list of property keys from the 'Compliance' domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example 'Compliance/live/UCITS'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ComplianceRuleResponse)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceTemplateAsync()

System.Threading.Tasks.Task<ComplianceTemplate> Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceTemplateAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template.

Use this endpoint to fetch a specific compliance template.

Exceptions

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

Parameters

scope	Scope of TemplateID
code	Code of TemplateID
asAt	Optional. The time at which to get results from. Default : latest (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceTemplateWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceTemplate> > Lusid.Sdk.Api.IComplianceApiAsync.GetComplianceTemplateWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template.

Use this endpoint to fetch a specific compliance template.

Exceptions

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

Parameters

scope	Scope of TemplateID
code	Code of TemplateID
asAt	Optional. The time at which to get results from. Default : latest (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ComplianceTemplate)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetDecoratedComplianceRunSummaryAsync()

System.Threading.Tasks.Task<DecoratedComplianceRunSummary> Lusid.Sdk.Api.IComplianceApiAsync.GetDecoratedComplianceRunSummaryAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run.

Specify a run scope and code from a previously run compliance check to get an overview of result details.

Exceptions

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

Parameters

scope	Required: Run Scope.
code	Required: Run Code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DecoratedComplianceRunSummary

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetDecoratedComplianceRunSummaryWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DecoratedComplianceRunSummary> > Lusid.Sdk.Api.IComplianceApiAsync.GetDecoratedComplianceRunSummaryWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run.

Specify a run scope and code from a previously run compliance check to get an overview of result details.

Exceptions

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

Parameters

scope	Required: Run Scope.
code	Required: Run Code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DecoratedComplianceRunSummary)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRulesAsync()

System.Threading.Tasks.Task<PagedResourceListOfComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceRulesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListComplianceRules: List compliance rules.

Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter.

Exceptions

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

Parameters

asAt	Optional. Asat time. (optional)
page	Optional. Pagination token. (optional)
limit	Optional. Entries per page. (optional)
filter	Optional. Filter. (optional)
propertyKeys	A list of property keys from the 'Compliance' domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example 'Compliance/live/UCITS'. If not provided will return all the entitled properties for each rule. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRulesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfComplianceRuleResponse> > Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceRulesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListComplianceRules: List compliance rules.

Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter.

Exceptions

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

Parameters

asAt	Optional. Asat time. (optional)
page	Optional. Pagination token. (optional)
limit	Optional. Entries per page. (optional)
filter	Optional. Filter. (optional)
propertyKeys	A list of property keys from the 'Compliance' domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example 'Compliance/live/UCITS'. If not provided will return all the entitled properties for each rule. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfComplianceRuleResponse)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRunsAsync()

System.Threading.Tasks.Task<PagedResourceListOfComplianceRunInfoV2> Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceRunsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.

Lists RunIds of prior compliance runs, or a subset with a filter.

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	Optional. 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	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Optional. A list of field names to sort by, each suffixed by "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRunsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfComplianceRunInfoV2> > Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceRunsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers.

Lists RunIds of prior compliance runs, or a subset with a filter.

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	Optional. 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	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Optional. A list of field names to sort by, each suffixed by "ASC" or "DESC" (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfComplianceRunInfoV2)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceTemplatesAsync()

System.Threading.Tasks.Task<PagedResourceListOfComplianceTemplate> Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceTemplatesAsync	(	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)`
	)

[EARLY ACCESS] ListComplianceTemplates: List compliance templates.

Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter.

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	Optional. 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	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. 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.

Returns: Task of PagedResourceListOfComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceTemplatesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfComplianceTemplate> > Lusid.Sdk.Api.IComplianceApiAsync.ListComplianceTemplatesWithHttpInfoAsync	(	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)`
	)

[EARLY ACCESS] ListComplianceTemplates: List compliance templates.

Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter.

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	Optional. 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	Optional. When paginating, limit the number of returned results to this many. (optional)
filter	Optional. 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.

Returns: Task of ApiResponse (PagedResourceListOfComplianceTemplate)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunComplianceAsync()

System.Threading.Tasks.Task<ComplianceRunInfoV2> Lusid.Sdk.Api.IComplianceApiAsync.RunComplianceAsync	(	string	runScope,
		string	ruleScope,
		bool	isPreTrade,
		string	recipeIdScope,
		string	recipeIdCode,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] RunCompliance: Run a compliance check.

Use this endpoint to run a compliance check using rules from a specific scope.

Exceptions

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

Parameters

runScope	Required: Scope to save the run results in.
ruleScope	Required: Scope from which to select rules to be run.
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	Required: The code of the recipe to be used. If left blank, the default recipe will be used.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunComplianceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRunInfoV2> > Lusid.Sdk.Api.IComplianceApiAsync.RunComplianceWithHttpInfoAsync	(	string	runScope,
		string	ruleScope,
		bool	isPreTrade,
		string	recipeIdScope,
		string	recipeIdCode,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] RunCompliance: Run a compliance check.

Use this endpoint to run a compliance check using rules from a specific scope.

Exceptions

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

Parameters

runScope	Required: Scope to save the run results in.
ruleScope	Required: Scope from which to select rules to be run.
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	Required: The code of the recipe to be used. If left blank, the default recipe will be used.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ComplianceRunInfoV2)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRuleAsync()

System.Threading.Tasks.Task<ComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiAsync.UpsertComplianceRuleAsync	(	UpsertComplianceRuleRequest?	upsertComplianceRuleRequest = `default(UpsertComplianceRuleRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.

Use this endpoint to upsert a single compliance rule. The template and variation specified must already exist, as must the portfolio group. The parameters passed must match those required by the template variation.

Exceptions

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

Parameters

upsertComplianceRuleRequest	(optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRuleWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRuleResponse> > Lusid.Sdk.Api.IComplianceApiAsync.UpsertComplianceRuleWithHttpInfoAsync	(	UpsertComplianceRuleRequest?	upsertComplianceRuleRequest = `default(UpsertComplianceRuleRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule.

Use this endpoint to upsert a single compliance rule. The template and variation specified must already exist, as must the portfolio group. The parameters passed must match those required by the template variation.

Exceptions

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

Parameters

upsertComplianceRuleRequest	(optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ComplianceRuleResponse)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRunSummaryAsync()

System.Threading.Tasks.Task<UpsertComplianceRunSummaryResult> Lusid.Sdk.Api.IComplianceApiAsync.UpsertComplianceRunSummaryAsync	(	UpsertComplianceRunSummaryRequest?	upsertComplianceRunSummaryRequest = `default(UpsertComplianceRunSummaryRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.

Use this endpoint to upsert a compliance run result summary.

Exceptions

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

Parameters

upsertComplianceRunSummaryRequest	(optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertComplianceRunSummaryResult

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRunSummaryWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertComplianceRunSummaryResult> > Lusid.Sdk.Api.IComplianceApiAsync.UpsertComplianceRunSummaryWithHttpInfoAsync	(	UpsertComplianceRunSummaryRequest?	upsertComplianceRunSummaryRequest = `default(UpsertComplianceRunSummaryRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary.

Use this endpoint to upsert a compliance run result summary.

Exceptions

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

Parameters

upsertComplianceRunSummaryRequest	(optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertComplianceRunSummaryResult)

Implemented in Lusid.Sdk.Api.ComplianceApi.

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/ComplianceApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteComplianceRuleAsync()

◆ DeleteComplianceRuleWithHttpInfoAsync()

◆ GetComplianceRuleAsync()

◆ GetComplianceRuleResultAsync()

◆ GetComplianceRuleResultWithHttpInfoAsync()

◆ GetComplianceRuleWithHttpInfoAsync()

◆ GetComplianceTemplateAsync()

◆ GetComplianceTemplateWithHttpInfoAsync()

◆ GetDecoratedComplianceRunSummaryAsync()

◆ GetDecoratedComplianceRunSummaryWithHttpInfoAsync()

◆ ListComplianceRulesAsync()

◆ ListComplianceRulesWithHttpInfoAsync()

◆ ListComplianceRunsAsync()

◆ ListComplianceRunsWithHttpInfoAsync()

◆ ListComplianceTemplatesAsync()

◆ ListComplianceTemplatesWithHttpInfoAsync()

◆ RunComplianceAsync()

◆ RunComplianceWithHttpInfoAsync()

◆ UpsertComplianceRuleAsync()

◆ UpsertComplianceRuleWithHttpInfoAsync()

◆ UpsertComplianceRunSummaryAsync()

◆ UpsertComplianceRunSummaryWithHttpInfoAsync()