LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
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, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | CreateAmortisationRuleSetWithHttpInfo (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | CreateAmortisationRuleSetAsync (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteAmortisationRulesetWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. More... | |
async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteAmortisationRulesetAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. 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), ConfigurationOptions? opts=null) |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone. More... | |
AmortisationRuleSet | GetAmortisationRuleSet (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | GetAmortisationRuleSetWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | GetAmortisationRuleSetAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAmortisationRuleSet > | 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, ConfigurationOptions? opts=null) |
[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< PagedResourceListOfAmortisationRuleSet > | 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), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | SetAmortisationRulesWithHttpInfo (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[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< AmortisationRuleSet > | SetAmortisationRulesAsync (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. More... | |
Lusid.Sdk.Client.ApiResponse< AmortisationRuleSet > | UpdateAmortisationRuleSetDetailsWithHttpInfo (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time. More... | |
async System.Threading.Tasks.Task< AmortisationRuleSet > | UpdateAmortisationRuleSetDetailsAsync (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the AmortisationRuleSetsApi class.
|
inline |
Initializes a new instance of the AmortisationRuleSetsApi class.
|
inline |
Initializes a new instance of the AmortisationRuleSetsApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the AmortisationRuleSetsApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the rule set. |
createAmortisationRuleSetRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the rule set. |
createAmortisationRuleSetRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the rule set. |
createAmortisationRuleSetRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the rule set. |
createAmortisationRuleSetRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. Deletes the rule set perpetually, including its rules. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
Gets the base path of the API client.
The base path
|
inline |
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. Retrieves all amortisation rule sets at the given effective and as at times
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional) |
page | The 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) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC" (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
setAmortisationRulesRequest | The contents of the rules. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
setAmortisationRulesRequest | The contents of the rules. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
setAmortisationRulesRequest | The contents of the rules. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
setAmortisationRulesRequest | The contents of the rules. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
updateAmortisationRuleSetDetailsRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
updateAmortisationRuleSetDetailsRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
inline |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
updateAmortisationRuleSetDetailsRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.
|
inline |
[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. Updates the amortisation rule set definition for all effective time.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The rule set scope. |
code | The rule set code. |
updateAmortisationRuleSetDetailsRequest | The contents of the rule set. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.