LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.ComplianceApi Class Reference

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

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

Public Member Functions

 ComplianceApi ()
 Initializes a new instance of the ComplianceApi class. More...
 
 ComplianceApi (string basePath)
 Initializes a new instance of the ComplianceApi class. More...
 
 ComplianceApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the ComplianceApi class using Configuration object More...
 
 ComplianceApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the ComplianceApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
ComplianceRuleTemplate CreateComplianceTemplate (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0)
 [EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template Use this endpoint to create a compliance template. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRuleTemplateCreateComplianceTemplateWithHttpInfo (string scope, CreateComplianceTemplateRequest createComplianceTemplateRequest, int operationIndex=0)
 [EARLY ACCESS] CreateComplianceTemplate: Create a Compliance Rule Template Use this endpoint to create a compliance template. More...
 
async 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 Use this endpoint to create a compliance template. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Use this endpoint to create a compliance template. More...
 
DeletedEntityResponse DeleteComplianceRule (string scope, string code, int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteComplianceRuleWithHttpInfo (string scope, string code, int operationIndex=0)
 [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. More...
 
async 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. 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > 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. More...
 
DeletedEntityResponse DeleteComplianceTemplate (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate Delete the compliance rule template uniquely defined by the scope and code. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteComplianceTemplateWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteComplianceTemplate: Delete a ComplianceRuleTemplate Delete the compliance rule template uniquely defined by the scope and code. More...
 
async 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 Delete the compliance rule template uniquely defined by the scope and code. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > 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. More...
 
ComplianceRuleResponse GetComplianceRule (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetComplianceRule: Get compliance rule. Use this endpoint to retrieve a single compliance rule. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRuleResponseGetComplianceRuleWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetComplianceRule: Get compliance rule. Use this endpoint to retrieve a single compliance rule. More...
 
async 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. Use this endpoint to retrieve a single compliance rule. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to retrieve a single compliance rule. More...
 
ComplianceRuleResultV2 GetComplianceRuleResult (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRuleResultV2GetComplianceRuleResultWithHttpInfo (string runScope, string runCode, string ruleScope, string ruleCode, int operationIndex=0)
 [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. More...
 
async 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. 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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. More...
 
ComplianceTemplate GetComplianceTemplate (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. Use this endpoint to fetch a specific compliance template. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceTemplateGetComplianceTemplateWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetComplianceTemplate: Get the requested compliance template. Use this endpoint to fetch a specific compliance template. More...
 
async 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. Use this endpoint to fetch a specific compliance template. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to fetch a specific compliance template. More...
 
DecoratedComplianceRunSummary GetDecoratedComplianceRunSummary (string scope, string code, int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< DecoratedComplianceRunSummaryGetDecoratedComplianceRunSummaryWithHttpInfo (string scope, string code, int operationIndex=0)
 [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. More...
 
async 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. Specify a run scope and code from a previously run compliance check to get an overview of result details. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Specify a run scope and code from a previously run compliance check to get an overview of result details. 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)
 [EARLY ACCESS] ListComplianceRules: List compliance rules. Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceRuleResponseListComplianceRulesWithHttpInfo (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)
 [EARLY ACCESS] ListComplianceRules: List compliance rules. Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. More...
 
async 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. Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to retrieve all compliance rules, or a subset defined by an optional filter. 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)
 [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. Lists RunIds of prior compliance runs, or a subset with a filter. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceRunInfoV2ListComplianceRunsWithHttpInfo (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)
 [EARLY ACCESS] ListComplianceRuns: List historical compliance run identifiers. Lists RunIds of prior compliance runs, or a subset with a filter. More...
 
async 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. Lists RunIds of prior compliance runs, or a subset with a filter. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Lists RunIds of prior compliance runs, or a subset with a filter. More...
 
PagedResourceListOfComplianceTemplate ListComplianceTemplates (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfComplianceTemplateListComplianceTemplatesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 [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. More...
 
async 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. Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to fetch a list of all available compliance template ids, or a subset using a filter. More...
 
ComplianceRunInfoV2 RunCompliance (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0)
 [EARLY ACCESS] RunCompliance: Run a compliance check. Use this endpoint to run a compliance check using rules from a specific scope. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRunInfoV2RunComplianceWithHttpInfo (string runScope, string ruleScope, bool isPreTrade, string recipeIdScope, string recipeIdCode, int operationIndex=0)
 [EARLY ACCESS] RunCompliance: Run a compliance check. Use this endpoint to run a compliance check using rules from a specific scope. More...
 
async 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. Use this endpoint to run a compliance check using rules from a specific scope. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to run a compliance check using rules from a specific scope. More...
 
ComplianceRuleTemplate UpdateComplianceTemplate (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate Use this endpoint to update a specified compliance template. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRuleTemplateUpdateComplianceTemplateWithHttpInfo (string scope, string code, UpdateComplianceTemplateRequest updateComplianceTemplateRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateComplianceTemplate: Update a ComplianceRuleTemplate Use this endpoint to update a specified compliance template. More...
 
async 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 Use this endpoint to update a specified compliance template. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Use this endpoint to update a specified compliance template. More...
 
ComplianceRuleResponse UpsertComplianceRule (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< ComplianceRuleResponseUpsertComplianceRuleWithHttpInfo (UpsertComplianceRuleRequest? upsertComplianceRuleRequest=default(UpsertComplianceRuleRequest?), int operationIndex=0)
 [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. More...
 
async 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. 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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. More...
 
UpsertComplianceRunSummaryResult UpsertComplianceRunSummary (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0)
 [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. Use this endpoint to upsert a compliance run result summary. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertComplianceRunSummaryResultUpsertComplianceRunSummaryWithHttpInfo (UpsertComplianceRunSummaryRequest? upsertComplianceRunSummaryRequest=default(UpsertComplianceRunSummaryRequest?), int operationIndex=0)
 [EARLY ACCESS] UpsertComplianceRunSummary: Upsert a compliance run summary. Use this endpoint to upsert a compliance run result summary. More...
 
async 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. Use this endpoint to upsert a compliance run result summary. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Use this endpoint to upsert a compliance run result summary. More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- 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

Constructor & Destructor Documentation

◆ ComplianceApi() [1/4]

Lusid.Sdk.Api.ComplianceApi.ComplianceApi ( )
inline

Initializes a new instance of the ComplianceApi class.

Returns

◆ ComplianceApi() [2/4]

Lusid.Sdk.Api.ComplianceApi.ComplianceApi ( string  basePath)
inline

Initializes a new instance of the ComplianceApi class.

Returns

◆ ComplianceApi() [3/4]

Lusid.Sdk.Api.ComplianceApi.ComplianceApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the ComplianceApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ ComplianceApi() [4/4]

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

Initializes a new instance of the ComplianceApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ CreateComplianceTemplate()

ComplianceRuleTemplate Lusid.Sdk.Api.ComplianceApi.CreateComplianceTemplate ( string  scope,
CreateComplianceTemplateRequest  createComplianceTemplateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRuleTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ CreateComplianceTemplateAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ CreateComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleTemplate> Lusid.Sdk.Api.ComplianceApi.CreateComplianceTemplateWithHttpInfo ( string  scope,
CreateComplianceTemplateRequest  createComplianceTemplateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRuleTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ CreateComplianceTemplateWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ DeleteComplianceRule()

DeletedEntityResponse Lusid.Sdk.Api.ComplianceApi.DeleteComplianceRule ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ DeleteComplianceRuleAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ DeleteComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ComplianceApi.DeleteComplianceRuleWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ DeleteComplianceRuleWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ DeleteComplianceTemplate()

DeletedEntityResponse Lusid.Sdk.Api.ComplianceApi.DeleteComplianceTemplate ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ DeleteComplianceTemplateAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ DeleteComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ComplianceApi.DeleteComplianceTemplateWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ DeleteComplianceTemplateWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.ComplianceApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetComplianceRule()

ComplianceRuleResponse Lusid.Sdk.Api.ComplianceApi.GetComplianceRule ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceRuleAsync()

async System.Threading.Tasks.Task<ComplianceRuleResponse> Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetComplianceRuleResult()

ComplianceRuleResultV2 Lusid.Sdk.Api.ComplianceApi.GetComplianceRuleResult ( string  runScope,
string  runCode,
string  ruleScope,
string  ruleCode,
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRuleResultV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceRuleResultAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetComplianceRuleResultWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResultV2> Lusid.Sdk.Api.ComplianceApi.GetComplianceRuleResultWithHttpInfo ( string  runScope,
string  runCode,
string  ruleScope,
string  ruleCode,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRuleResultV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceRuleResultWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResponse> Lusid.Sdk.Api.ComplianceApi.GetComplianceRuleWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceRuleWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ComplianceRuleResponse> > Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetComplianceTemplate()

ComplianceTemplate Lusid.Sdk.Api.ComplianceApi.GetComplianceTemplate ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceTemplateAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceTemplate> Lusid.Sdk.Api.ComplianceApi.GetComplianceTemplateWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetComplianceTemplateWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetDecoratedComplianceRunSummary()

DecoratedComplianceRunSummary Lusid.Sdk.Api.ComplianceApi.GetDecoratedComplianceRunSummary ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
DecoratedComplianceRunSummary

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetDecoratedComplianceRunSummaryAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ GetDecoratedComplianceRunSummaryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DecoratedComplianceRunSummary> Lusid.Sdk.Api.ComplianceApi.GetDecoratedComplianceRunSummaryWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of DecoratedComplianceRunSummary

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ GetDecoratedComplianceRunSummaryWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceRules()

PagedResourceListOfComplianceRuleResponse Lusid.Sdk.Api.ComplianceApi.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 
)
inline

[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.
Returns
PagedResourceListOfComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceRulesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfComplianceRuleResponse> Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRuleResponse> Lusid.Sdk.Api.ComplianceApi.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 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRuleResponse> > Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceRuns()

PagedResourceListOfComplianceRunInfoV2 Lusid.Sdk.Api.ComplianceApi.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 
)
inline

[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.
Returns
PagedResourceListOfComplianceRunInfoV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceRunsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfComplianceRunInfoV2> Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceRunsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRunInfoV2> Lusid.Sdk.Api.ComplianceApi.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 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfComplianceRunInfoV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceRunsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceRunInfoV2> > Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceTemplates()

PagedResourceListOfComplianceTemplate Lusid.Sdk.Api.ComplianceApi.ListComplianceTemplates ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)
inline

[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.
Returns
PagedResourceListOfComplianceTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceTemplatesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfComplianceTemplate> Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ ListComplianceTemplatesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceTemplate> Lusid.Sdk.Api.ComplianceApi.ListComplianceTemplatesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfComplianceTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ ListComplianceTemplatesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfComplianceTemplate> > Lusid.Sdk.Api.ComplianceApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ RunCompliance()

ComplianceRunInfoV2 Lusid.Sdk.Api.ComplianceApi.RunCompliance ( string  runScope,
string  ruleScope,
bool  isPreTrade,
string  recipeIdScope,
string  recipeIdCode,
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRunInfoV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ RunComplianceAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ RunComplianceWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRunInfoV2> Lusid.Sdk.Api.ComplianceApi.RunComplianceWithHttpInfo ( string  runScope,
string  ruleScope,
bool  isPreTrade,
string  recipeIdScope,
string  recipeIdCode,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRunInfoV2

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ RunComplianceWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpdateComplianceTemplate()

ComplianceRuleTemplate Lusid.Sdk.Api.ComplianceApi.UpdateComplianceTemplate ( string  scope,
string  code,
UpdateComplianceTemplateRequest  updateComplianceTemplateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRuleTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpdateComplianceTemplateAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpdateComplianceTemplateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleTemplate> Lusid.Sdk.Api.ComplianceApi.UpdateComplianceTemplateWithHttpInfo ( string  scope,
string  code,
UpdateComplianceTemplateRequest  updateComplianceTemplateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRuleTemplate

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpdateComplianceTemplateWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpsertComplianceRule()

ComplianceRuleResponse Lusid.Sdk.Api.ComplianceApi.UpsertComplianceRule ( UpsertComplianceRuleRequest upsertComplianceRuleRequest = default(UpsertComplianceRuleRequest?),
int  operationIndex = 0 
)
inline

[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.
Returns
ComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpsertComplianceRuleAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpsertComplianceRuleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ComplianceRuleResponse> Lusid.Sdk.Api.ComplianceApi.UpsertComplianceRuleWithHttpInfo ( UpsertComplianceRuleRequest upsertComplianceRuleRequest = default(UpsertComplianceRuleRequest?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of ComplianceRuleResponse

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpsertComplianceRuleWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpsertComplianceRunSummary()

UpsertComplianceRunSummaryResult Lusid.Sdk.Api.ComplianceApi.UpsertComplianceRunSummary ( UpsertComplianceRunSummaryRequest upsertComplianceRunSummaryRequest = default(UpsertComplianceRunSummaryRequest?),
int  operationIndex = 0 
)
inline

[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.
Returns
UpsertComplianceRunSummaryResult

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpsertComplianceRunSummaryAsync()

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

[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

Implements Lusid.Sdk.Api.IComplianceApiAsync.

◆ UpsertComplianceRunSummaryWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertComplianceRunSummaryResult> Lusid.Sdk.Api.ComplianceApi.UpsertComplianceRunSummaryWithHttpInfo ( UpsertComplianceRunSummaryRequest upsertComplianceRunSummaryRequest = default(UpsertComplianceRunSummaryRequest?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of UpsertComplianceRunSummaryResult

Implements Lusid.Sdk.Api.IComplianceApiSync.

◆ UpsertComplianceRunSummaryWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.IComplianceApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ComplianceApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ComplianceApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ComplianceApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.ComplianceApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: