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

Inheritance diagram for Lusid.Sdk.Api.IComplianceApiSync:

[legend]

Public Member Functions
ComplianceRuleTemplate	CreateComplianceTemplate (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleTemplate >	CreateComplianceTemplateWithHttpInfo (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template More...

DeletedEntityResponse	DeleteComplianceRule (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteComplianceRuleWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteComplianceRule: Delete compliance rule. More...

DeletedEntityResponse	DeleteComplianceTemplate (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteComplianceTemplateWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate More...

ComplianceRuleResponse	GetComplianceRule (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceRule: Get compliance rule. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleResponse >	GetComplianceRuleWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceRule: Get compliance rule. More...

ComplianceRuleResultV2	GetComplianceRuleResult (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleResultV2 >	GetComplianceRuleResultWithHttpInfo (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceRuleResult: Get detailed results for a specific rule within a compliance run. More...

ComplianceTemplate	GetComplianceTemplate (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. More...

Lusid.Sdk.Client.ApiResponse< ComplianceTemplate >	GetComplianceTemplateWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. More...

DecoratedComplianceRunSummary	GetDecoratedComplianceRunSummary (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. More...

Lusid.Sdk.Client.ApiResponse< DecoratedComplianceRunSummary >	GetDecoratedComplianceRunSummaryWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetDecoratedComplianceRunSummary: Get decorated summary results for a specific compliance run. More...

PagedResourceListOfComplianceRuleResponse	ListComplianceRules (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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceRules: List compliance rules. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceRuleResponse >	ListComplianceRulesWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceRules: List compliance rules. More...

PagedResourceListOfComplianceRunInfoV2	ListComplianceRuns (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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceRunInfoV2 >	ListComplianceRunsWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. More...

PagedResourceListOfComplianceTemplate	ListComplianceTemplates (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceTemplates: List compliance templates. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceTemplate >	ListComplianceTemplatesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] ListComplianceTemplates: List compliance templates. More...

ComplianceRunInfoV2	RunCompliance (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] RunCompliance: Run a compliance check. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRunInfoV2 >	RunComplianceWithHttpInfo (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] RunCompliance: Run a compliance check. More...

ComplianceRunInfoV2	RunCompliancePreview (string runScope, string ruleScope, string recipeIdScope, string recipeIdCode, ComplianceRunConfiguration? complianceRunConfiguration=default(ComplianceRunConfiguration?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] RunCompliancePreview: Run a compliance check. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRunInfoV2 >	RunCompliancePreviewWithHttpInfo (string runScope, string ruleScope, string recipeIdScope, string recipeIdCode, ComplianceRunConfiguration? complianceRunConfiguration=default(ComplianceRunConfiguration?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] RunCompliancePreview: Run a compliance check. More...

ComplianceRuleTemplate	UpdateComplianceTemplate (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleTemplate >	UpdateComplianceTemplateWithHttpInfo (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate More...

ComplianceRuleResponse	UpsertComplianceRule (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. More...

Lusid.Sdk.Client.ApiResponse< ComplianceRuleResponse >	UpsertComplianceRuleWithHttpInfo (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertComplianceRule: Upsert a compliance rule. More...

UpsertComplianceRunSummaryResult	UpsertComplianceRunSummary (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. More...

Lusid.Sdk.Client.ApiResponse< UpsertComplianceRunSummaryResult >	UpsertComplianceRunSummaryWithHttpInfo (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateComplianceTemplate()

ComplianceRuleTemplate Lusid.Sdk.Api.IComplianceApiSync.CreateComplianceTemplate	(	string	scope,
		CreateComplianceTemplateRequest	createComplianceTemplateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template

Use this endpoint to create a compliance template.

Exceptions

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

Parameters

scope	The scope of the Compliance Rule Template.
createComplianceTemplateRequest	Request to create a compliance rule template.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ CreateComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleTemplate> Lusid.Sdk.Api.IComplianceApiSync.CreateComplianceTemplateWithHttpInfo	(	string	scope,
		CreateComplianceTemplateRequest	createComplianceTemplateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template

Use this endpoint to create a compliance template.

Exceptions

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

Parameters

scope	The scope of the Compliance Rule Template.
createComplianceTemplateRequest	Request to create a compliance rule template.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceRule()

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

[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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceRuleWithHttpInfo()

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

[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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceTemplate()

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

[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate

Delete the compliance rule template uniquely defined by the scope and code.

Exceptions

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

Parameters

scope	The scope of the template to be deleted.
code	The code of the template to be deleted.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceTemplateWithHttpInfo()

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

[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate

Delete the compliance rule template uniquely defined by the scope and code.

Exceptions

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

Parameters

scope	The scope of the template to be deleted.
code	The code of the template to be deleted.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRule()

ComplianceRuleResponse Lusid.Sdk.Api.IComplianceApiSync.GetComplianceRule	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleResult()

ComplianceRuleResultV2 Lusid.Sdk.Api.IComplianceApiSync.GetComplianceRuleResult	(	string	runScope,
		string	runCode,
		string	ruleScope,
		string	ruleCode,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ComplianceRuleResultV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleResultWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResultV2> Lusid.Sdk.Api.IComplianceApiSync.GetComplianceRuleResultWithHttpInfo	(	string	runScope,
		string	runCode,
		string	ruleScope,
		string	ruleCode,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleResultV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiSync.GetComplianceRuleWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceTemplate()

ComplianceTemplate Lusid.Sdk.Api.IComplianceApiSync.GetComplianceTemplate	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceTemplate> Lusid.Sdk.Api.IComplianceApiSync.GetComplianceTemplateWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of ComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetDecoratedComplianceRunSummary()

DecoratedComplianceRunSummary Lusid.Sdk.Api.IComplianceApiSync.GetDecoratedComplianceRunSummary	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: DecoratedComplianceRunSummary

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ GetDecoratedComplianceRunSummaryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DecoratedComplianceRunSummary> Lusid.Sdk.Api.IComplianceApiSync.GetDecoratedComplianceRunSummaryWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of DecoratedComplianceRunSummary

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRules()

PagedResourceListOfComplianceRuleResponse Lusid.Sdk.Api.IComplianceApiSync.ListComplianceRules	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: PagedResourceListOfComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiSync.ListComplianceRulesWithHttpInfo	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRuns()

PagedResourceListOfComplianceRunInfoV2 Lusid.Sdk.Api.IComplianceApiSync.ListComplianceRuns	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: PagedResourceListOfComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceRunsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRunInfoV2> Lusid.Sdk.Api.IComplianceApiSync.ListComplianceRunsWithHttpInfo	(	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`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceTemplates()

PagedResourceListOfComplianceTemplate Lusid.Sdk.Api.IComplianceApiSync.ListComplianceTemplates	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: PagedResourceListOfComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ ListComplianceTemplatesWithHttpInfo()

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

[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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfComplianceTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunCompliance()

ComplianceRunInfoV2 Lusid.Sdk.Api.IComplianceApiSync.RunCompliance	(	string	runScope,
		string	ruleScope,
		bool	isPreTrade,
		string	recipeIdScope,
		string	recipeIdCode,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunCompliancePreview()

ComplianceRunInfoV2 Lusid.Sdk.Api.IComplianceApiSync.RunCompliancePreview	(	string	runScope,
		string	ruleScope,
		string	recipeIdScope,
		string	recipeIdCode,
		ComplianceRunConfiguration?	complianceRunConfiguration = `default(ComplianceRunConfiguration?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] RunCompliancePreview: 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.
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.
complianceRunConfiguration	Configuration options for the compliance run. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunCompliancePreviewWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRunInfoV2> Lusid.Sdk.Api.IComplianceApiSync.RunCompliancePreviewWithHttpInfo	(	string	runScope,
		string	ruleScope,
		string	recipeIdScope,
		string	recipeIdCode,
		ComplianceRunConfiguration?	complianceRunConfiguration = `default(ComplianceRunConfiguration?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] RunCompliancePreview: 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.
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.
complianceRunConfiguration	Configuration options for the compliance run. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ RunComplianceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRunInfoV2> Lusid.Sdk.Api.IComplianceApiSync.RunComplianceWithHttpInfo	(	string	runScope,
		string	ruleScope,
		bool	isPreTrade,
		string	recipeIdScope,
		string	recipeIdCode,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of ComplianceRunInfoV2

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpdateComplianceTemplate()

ComplianceRuleTemplate Lusid.Sdk.Api.IComplianceApiSync.UpdateComplianceTemplate	(	string	scope,
		string	code,
		UpdateComplianceTemplateRequest	updateComplianceTemplateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate

Use this endpoint to update a specified compliance template.

Exceptions

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

Parameters

scope	The scope of the Compliance Rule Template.
code	The code of the Compliance Rule Template.
updateComplianceTemplateRequest	Request to update a compliance rule template.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpdateComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleTemplate> Lusid.Sdk.Api.IComplianceApiSync.UpdateComplianceTemplateWithHttpInfo	(	string	scope,
		string	code,
		UpdateComplianceTemplateRequest	updateComplianceTemplateRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate

Use this endpoint to update a specified compliance template.

Exceptions

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

Parameters

scope	The scope of the Compliance Rule Template.
code	The code of the Compliance Rule Template.
updateComplianceTemplateRequest	Request to update a compliance rule template.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRule()

ComplianceRuleResponse Lusid.Sdk.Api.IComplianceApiSync.UpsertComplianceRule	(	UpsertComplianceRuleRequest?	upsertComplianceRuleRequest = `default(UpsertComplianceRuleRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResponse> Lusid.Sdk.Api.IComplianceApiSync.UpsertComplianceRuleWithHttpInfo	(	UpsertComplianceRuleRequest?	upsertComplianceRuleRequest = `default(UpsertComplianceRuleRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of ComplianceRuleResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRunSummary()

UpsertComplianceRunSummaryResult Lusid.Sdk.Api.IComplianceApiSync.UpsertComplianceRunSummary	(	UpsertComplianceRunSummaryRequest?	upsertComplianceRunSummaryRequest = `default(UpsertComplianceRunSummaryRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: UpsertComplianceRunSummaryResult

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpsertComplianceRunSummaryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertComplianceRunSummaryResult> Lusid.Sdk.Api.IComplianceApiSync.UpsertComplianceRunSummaryWithHttpInfo	(	UpsertComplianceRunSummaryRequest?	upsertComplianceRunSummaryRequest = `default(UpsertComplianceRunSummaryRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

[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.
opts	Options for this request.

Returns: ApiResponse of 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

Detailed Description

Member Function Documentation

◆ CreateComplianceTemplate()

◆ CreateComplianceTemplateWithHttpInfo()

◆ DeleteComplianceRule()

◆ DeleteComplianceRuleWithHttpInfo()

◆ DeleteComplianceTemplate()

◆ DeleteComplianceTemplateWithHttpInfo()

◆ GetComplianceRule()

◆ GetComplianceRuleResult()

◆ GetComplianceRuleResultWithHttpInfo()

◆ GetComplianceRuleWithHttpInfo()

◆ GetComplianceTemplate()

◆ GetComplianceTemplateWithHttpInfo()

◆ GetDecoratedComplianceRunSummary()

◆ GetDecoratedComplianceRunSummaryWithHttpInfo()

◆ ListComplianceRules()

◆ ListComplianceRulesWithHttpInfo()

◆ ListComplianceRuns()

◆ ListComplianceRunsWithHttpInfo()

◆ ListComplianceTemplates()

◆ ListComplianceTemplatesWithHttpInfo()

◆ RunCompliance()

◆ RunCompliancePreview()

◆ RunCompliancePreviewWithHttpInfo()

◆ RunComplianceWithHttpInfo()

◆ UpdateComplianceTemplate()

◆ UpdateComplianceTemplateWithHttpInfo()

◆ UpsertComplianceRule()

◆ UpsertComplianceRuleWithHttpInfo()

◆ UpsertComplianceRunSummary()

◆ UpsertComplianceRunSummaryWithHttpInfo()