LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IComplianceApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IComplianceApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< ComplianceRuleTemplateCreateComplianceTemplateAsync (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template More...
 
System.Threading.Tasks.Task< ApiResponse< ComplianceRuleTemplate > > CreateComplianceTemplateWithHttpInfoAsync (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteComplianceRuleAsync (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< DeletedEntityResponseDeleteComplianceTemplateAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteComplianceTemplateWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate More...
 
System.Threading.Tasks.Task< ComplianceRuleResponseGetComplianceRuleAsync (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< ComplianceRuleResultV2GetComplianceRuleResultAsync (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< ComplianceTemplateGetComplianceTemplateAsync (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< DecoratedComplianceRunSummaryGetDecoratedComplianceRunSummaryAsync (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< PagedResourceListOfComplianceRuleResponseListComplianceRulesAsync (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< PagedResourceListOfComplianceRunInfoV2ListComplianceRunsAsync (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< PagedResourceListOfComplianceTemplateListComplianceTemplatesAsync (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< ComplianceRunInfoV2RunComplianceAsync (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< ComplianceRuleTemplateUpdateComplianceTemplateAsync (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate More...
 
System.Threading.Tasks.Task< ApiResponse< ComplianceRuleTemplate > > UpdateComplianceTemplateWithHttpInfoAsync (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate More...
 
System.Threading.Tasks.Task< ComplianceRuleResponseUpsertComplianceRuleAsync (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< UpsertComplianceRunSummaryResultUpsertComplianceRunSummaryAsync (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

◆ CreateComplianceTemplateAsync()

System.Threading.Tasks.Task<ComplianceRuleTemplate> Lusid.Sdk.Api.IComplianceApiAsync.CreateComplianceTemplateAsync ( string  scope,
CreateComplianceTemplateRequest  createComplianceTemplateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template

Use this endpoint to create a compliance template.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Compliance Rule Template.
createComplianceTemplateRequestRequest to create a compliance rule template.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ CreateComplianceTemplateWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRuleTemplate> > Lusid.Sdk.Api.IComplianceApiAsync.CreateComplianceTemplateWithHttpInfoAsync ( string  scope,
CreateComplianceTemplateRequest  createComplianceTemplateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template

Use this endpoint to create a compliance template.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Compliance Rule Template.
createComplianceTemplateRequestRequest to create a compliance rule template.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ComplianceRuleTemplate)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule&#39;s scope.
codeThe compliance rule&#39;s code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule&#39;s scope.
codeThe compliance rule&#39;s code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceTemplateAsync()

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

[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the template to be deleted.
codeThe code of the template to be deleted.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ DeleteComplianceTemplateWithHttpInfoAsync()

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

[EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the template to be deleted.
codeThe code of the template to be deleted.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule&#39;s scope.
codeThe compliance rule&#39;s code.
asAtOptional. Asat time for query. (optional)
propertyKeysA list of property keys from the &#39;Compliance&#39; domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example &#39;Compliance/live/UCITS&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
runScopeRequired: Run Scope.
runCodeRequired: Run Code.
ruleScopeRequired: Rule Scope.
ruleCodeRequired: Rule Code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
runScopeRequired: Run Scope.
runCodeRequired: Run Code.
ruleScopeRequired: Rule Scope.
ruleCodeRequired: Rule Code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe compliance rule&#39;s scope.
codeThe compliance rule&#39;s code.
asAtOptional. Asat time for query. (optional)
propertyKeysA list of property keys from the &#39;Compliance&#39; domain to decorate onto the rule. These must take the format {domain}/{scope}/{code}, for example &#39;Compliance/live/UCITS&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of TemplateID
codeCode of TemplateID
asAtOptional. The time at which to get results from. Default : latest (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of TemplateID
codeCode of TemplateID
asAtOptional. The time at which to get results from. Default : latest (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeRequired: Run Scope.
codeRequired: Run Code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
scopeRequired: Run Scope.
codeRequired: Run Code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. Asat time. (optional)
pageOptional. Pagination token. (optional)
limitOptional. Entries per page. (optional)
filterOptional. Filter. (optional)
propertyKeysA list of property keys from the &#39;Compliance&#39; domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example &#39;Compliance/live/UCITS&#39;. If not provided will return all the entitled properties for each rule. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. Asat time. (optional)
pageOptional. Pagination token. (optional)
limitOptional. Entries per page. (optional)
filterOptional. Filter. (optional)
propertyKeysA list of property keys from the &#39;Compliance&#39; domain to decorate onto each rule. These must take the format {domain}/{scope}/{code}, for example &#39;Compliance/live/UCITS&#39;. If not provided will return all the entitled properties for each rule. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageOptional. 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)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByOptional. A list of field names to sort by, each suffixed by &quot;ASC&quot; or &quot;DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageOptional. 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)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByOptional. A list of field names to sort by, each suffixed by &quot;ASC&quot; or &quot;DESC&quot; (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageOptional. 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)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
asAtOptional. The time at which to get results from. Default : latest (optional)
pageOptional. 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)
limitOptional. When paginating, limit the number of returned results to this many. (optional)
filterOptional. Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
runScopeRequired: Scope to save the run results in.
ruleScopeRequired: Scope from which to select rules to be run.
isPreTradeRequired: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScopeRequired: the scope of the recipe to be used
recipeIdCodeRequired: The code of the recipe to be used. If left blank, the default recipe will be used.
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
runScopeRequired: Scope to save the run results in.
ruleScopeRequired: Scope from which to select rules to be run.
isPreTradeRequired: Boolean flag indicating if a run should be PreTrade (Including orders). For post-trade only, set to false
recipeIdScopeRequired: the scope of the recipe to be used
recipeIdCodeRequired: The code of the recipe to be used. If left blank, the default recipe will be used.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ComplianceRunInfoV2)

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpdateComplianceTemplateAsync()

System.Threading.Tasks.Task<ComplianceRuleTemplate> Lusid.Sdk.Api.IComplianceApiAsync.UpdateComplianceTemplateAsync ( string  scope,
string  code,
UpdateComplianceTemplateRequest  updateComplianceTemplateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate

Use this endpoint to update a specified compliance template.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Compliance Rule Template.
codeThe code of the Compliance Rule Template.
updateComplianceTemplateRequestRequest to update a compliance rule template.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ComplianceRuleTemplate

Implemented in Lusid.Sdk.Api.ComplianceApi.

◆ UpdateComplianceTemplateWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ComplianceRuleTemplate> > Lusid.Sdk.Api.IComplianceApiAsync.UpdateComplianceTemplateWithHttpInfoAsync ( string  scope,
string  code,
UpdateComplianceTemplateRequest  updateComplianceTemplateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate

Use this endpoint to update a specified compliance template.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Compliance Rule Template.
codeThe code of the Compliance Rule Template.
updateComplianceTemplateRequestRequest to update a compliance rule template.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ComplianceRuleTemplate)

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.ApiExceptionThrown when fails to make API call
Parameters
upsertComplianceRuleRequest(optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
upsertComplianceRuleRequest(optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
upsertComplianceRunSummaryRequest(optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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.ApiExceptionThrown when fails to make API call
Parameters
upsertComplianceRunSummaryRequest(optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation 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: