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

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

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

Public Member Functions

 AmortisationRuleSetsApi ()
 Initializes a new instance of the AmortisationRuleSetsApi class. More...
 
 AmortisationRuleSetsApi (string basePath)
 Initializes a new instance of the AmortisationRuleSetsApi class. More...
 
 AmortisationRuleSetsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the AmortisationRuleSetsApi class using Configuration object More...
 
 AmortisationRuleSetsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the AmortisationRuleSetsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
AmortisationRuleSet CreateAmortisationRuleSet (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...
 
Lusid.Sdk.Client.ApiResponse< AmortisationRuleSetCreateAmortisationRuleSetWithHttpInfo (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...
 
async System.Threading.Tasks.Task< AmortisationRuleSetCreateAmortisationRuleSetAsync (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AmortisationRuleSet > > CreateAmortisationRuleSetWithHttpInfoAsync (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...
 
DeletedEntityResponse DeleteAmortisationRuleset (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.
More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteAmortisationRulesetWithHttpInfo (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.
More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteAmortisationRulesetAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.
More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteAmortisationRulesetWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.
More...
 
AmortisationRuleSet GetAmortisationRuleSet (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times. More...
 
Lusid.Sdk.Client.ApiResponse< AmortisationRuleSetGetAmortisationRuleSetWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times. More...
 
async System.Threading.Tasks.Task< AmortisationRuleSetGetAmortisationRuleSetAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AmortisationRuleSet > > GetAmortisationRuleSetWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times. More...
 
PagedResourceListOfAmortisationRuleSet ListAmortisationRuleSets (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), 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)
 [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAmortisationRuleSetListAmortisationRuleSetsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), 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)
 [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times More...
 
async System.Threading.Tasks.Task< PagedResourceListOfAmortisationRuleSetListAmortisationRuleSetsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), 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))
 [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAmortisationRuleSet > > ListAmortisationRuleSetsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), 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))
 [EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times More...
 
AmortisationRuleSet SetAmortisationRules (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0)
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided. More...
 
Lusid.Sdk.Client.ApiResponse< AmortisationRuleSetSetAmortisationRulesWithHttpInfo (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0)
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided. More...
 
async System.Threading.Tasks.Task< AmortisationRuleSetSetAmortisationRulesAsync (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AmortisationRuleSet > > SetAmortisationRulesWithHttpInfoAsync (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided. More...
 
AmortisationRuleSet UpdateAmortisationRuleSetDetails (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0)
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. More...
 
Lusid.Sdk.Client.ApiResponse< AmortisationRuleSetUpdateAmortisationRuleSetDetailsWithHttpInfo (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0)
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. More...
 
async System.Threading.Tasks.Task< AmortisationRuleSetUpdateAmortisationRuleSetDetailsAsync (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AmortisationRuleSet > > UpdateAmortisationRuleSetDetailsWithHttpInfoAsync (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. 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

◆ AmortisationRuleSetsApi() [1/4]

Lusid.Sdk.Api.AmortisationRuleSetsApi.AmortisationRuleSetsApi ( )
inline

Initializes a new instance of the AmortisationRuleSetsApi class.

Returns

◆ AmortisationRuleSetsApi() [2/4]

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

Initializes a new instance of the AmortisationRuleSetsApi class.

Returns

◆ AmortisationRuleSetsApi() [3/4]

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

Initializes a new instance of the AmortisationRuleSetsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ AmortisationRuleSetsApi() [4/4]

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

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

◆ CreateAmortisationRuleSet()

AmortisationRuleSet Lusid.Sdk.Api.AmortisationRuleSetsApi.CreateAmortisationRuleSet ( string  scope,
CreateAmortisationRuleSetRequest  createAmortisationRuleSetRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the rule set.
createAmortisationRuleSetRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
Returns
AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ CreateAmortisationRuleSetAsync()

async System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.CreateAmortisationRuleSetAsync ( string  scope,
CreateAmortisationRuleSetRequest  createAmortisationRuleSetRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the rule set.
createAmortisationRuleSetRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ CreateAmortisationRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.CreateAmortisationRuleSetWithHttpInfo ( string  scope,
CreateAmortisationRuleSetRequest  createAmortisationRuleSetRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the rule set.
createAmortisationRuleSetRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ CreateAmortisationRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.AmortisationRuleSetsApi.CreateAmortisationRuleSetWithHttpInfoAsync ( string  scope,
CreateAmortisationRuleSetRequest  createAmortisationRuleSetRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. Creates an amortisation rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the rule set.
createAmortisationRuleSetRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AmortisationRuleSet)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ DeleteAmortisationRuleset()

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

[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ DeleteAmortisationRulesetAsync()

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

[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.

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

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ DeleteAmortisationRulesetWithHttpInfo()

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

[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ DeleteAmortisationRulesetWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. <br> Deletes the rule set perpetually, including its rules. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ GetAmortisationRuleSet()

AmortisationRuleSet Lusid.Sdk.Api.AmortisationRuleSetsApi.GetAmortisationRuleSet ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ GetAmortisationRuleSetAsync()

async System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.GetAmortisationRuleSetAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ GetAmortisationRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.GetAmortisationRuleSetWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ GetAmortisationRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.AmortisationRuleSetsApi.GetAmortisationRuleSetWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set Retrieves the amortisation rule set definition at the given effective and as at times.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
effectiveAtThe effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AmortisationRuleSet)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListAmortisationRuleSets()

PagedResourceListOfAmortisationRuleSet Lusid.Sdk.Api.AmortisationRuleSetsApi.ListAmortisationRuleSets ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
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

[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing AmortisationRuleSets; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfAmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ ListAmortisationRuleSetsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfAmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.ListAmortisationRuleSetsAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
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

[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing AmortisationRuleSets; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties 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 PagedResourceListOfAmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ ListAmortisationRuleSetsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.ListAmortisationRuleSetsWithHttpInfo ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
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

[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing AmortisationRuleSets; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfAmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ ListAmortisationRuleSetsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAmortisationRuleSet> > Lusid.Sdk.Api.AmortisationRuleSetsApi.ListAmortisationRuleSetsWithHttpInfoAsync ( DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
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

[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
pageThe pagination token to use to continue listing AmortisationRuleSets; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties 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 (PagedResourceListOfAmortisationRuleSet)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ SetAmortisationRules()

AmortisationRuleSet Lusid.Sdk.Api.AmortisationRuleSetsApi.SetAmortisationRules ( string  scope,
string  code,
SetAmortisationRulesRequest  setAmortisationRulesRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
setAmortisationRulesRequestThe contents of the rules.
operationIndexIndex associated with the operation.
Returns
AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ SetAmortisationRulesAsync()

async System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.SetAmortisationRulesAsync ( string  scope,
string  code,
SetAmortisationRulesRequest  setAmortisationRulesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
setAmortisationRulesRequestThe contents of the rules.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ SetAmortisationRulesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.SetAmortisationRulesWithHttpInfo ( string  scope,
string  code,
SetAmortisationRulesRequest  setAmortisationRulesRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
setAmortisationRulesRequestThe contents of the rules.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ SetAmortisationRulesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.AmortisationRuleSetsApi.SetAmortisationRulesWithHttpInfoAsync ( string  scope,
string  code,
SetAmortisationRulesRequest  setAmortisationRulesRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. Sets the rules on the Amortisation Rule Set, replacing the existing rules with the set provided.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
setAmortisationRulesRequestThe contents of the rules.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AmortisationRuleSet)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ UpdateAmortisationRuleSetDetails()

AmortisationRuleSet Lusid.Sdk.Api.AmortisationRuleSetsApi.UpdateAmortisationRuleSetDetails ( string  scope,
string  code,
UpdateAmortisationRuleSetDetailsRequest  updateAmortisationRuleSetDetailsRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
updateAmortisationRuleSetDetailsRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
Returns
AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ UpdateAmortisationRuleSetDetailsAsync()

async System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.UpdateAmortisationRuleSetDetailsAsync ( string  scope,
string  code,
UpdateAmortisationRuleSetDetailsRequest  updateAmortisationRuleSetDetailsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
updateAmortisationRuleSetDetailsRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

◆ UpdateAmortisationRuleSetDetailsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.AmortisationRuleSetsApi.UpdateAmortisationRuleSetDetailsWithHttpInfo ( string  scope,
string  code,
UpdateAmortisationRuleSetDetailsRequest  updateAmortisationRuleSetDetailsRequest,
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
updateAmortisationRuleSetDetailsRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
Returns
ApiResponse of AmortisationRuleSet

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.

◆ UpdateAmortisationRuleSetDetailsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.AmortisationRuleSetsApi.UpdateAmortisationRuleSetDetailsWithHttpInfoAsync ( string  scope,
string  code,
UpdateAmortisationRuleSetDetailsRequest  updateAmortisationRuleSetDetailsRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe rule set scope.
codeThe rule set code.
updateAmortisationRuleSetDetailsRequestThe contents of the rule set.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AmortisationRuleSet)

Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AmortisationRuleSetsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.AmortisationRuleSetsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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