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

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

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

Public Member Functions

AmortisationRuleSet CreateAmortisationRuleSet (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. More...
 
ApiResponse< AmortisationRuleSetCreateAmortisationRuleSetWithHttpInfo (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0)
 [EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. More...
 
DeletedEntityResponse DeleteAmortisationRuleset (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. More...
 
ApiResponse< DeletedEntityResponseDeleteAmortisationRulesetWithHttpInfo (string scope, string code, int operationIndex=0)
 [EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. 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 More...
 
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 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. More...
 
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. More...
 
AmortisationRuleSet SetAmortisationRules (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0)
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. More...
 
ApiResponse< AmortisationRuleSetSetAmortisationRulesWithHttpInfo (string scope, string code, SetAmortisationRulesRequest setAmortisationRulesRequest, int operationIndex=0)
 [EXPERIMENTAL] SetAmortisationRules: Set Amortisation Rules on an existing Amortisation Rule Set. More...
 
AmortisationRuleSet UpdateAmortisationRuleSetDetails (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0)
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. More...
 
ApiResponse< AmortisationRuleSetUpdateAmortisationRuleSetDetailsWithHttpInfo (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0)
 [EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateAmortisationRuleSet()

AmortisationRuleSet Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ CreateAmortisationRuleSetWithHttpInfo()

ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.CreateAmortisationRuleSetWithHttpInfo ( 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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ DeleteAmortisationRuleset()

DeletedEntityResponse Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ DeleteAmortisationRulesetWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.DeleteAmortisationRulesetWithHttpInfo ( 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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ GetAmortisationRuleSet()

AmortisationRuleSet Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ GetAmortisationRuleSetWithHttpInfo()

ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.GetAmortisationRuleSetWithHttpInfo ( 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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ ListAmortisationRuleSets()

PagedResourceListOfAmortisationRuleSet Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ ListAmortisationRuleSetsWithHttpInfo()

ApiResponse<PagedResourceListOfAmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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 
)

[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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ SetAmortisationRules()

AmortisationRuleSet Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ SetAmortisationRulesWithHttpInfo()

ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.SetAmortisationRulesWithHttpInfo ( 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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ UpdateAmortisationRuleSetDetails()

AmortisationRuleSet Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ UpdateAmortisationRuleSetDetailsWithHttpInfo()

ApiResponse<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiSync.UpdateAmortisationRuleSetDetailsWithHttpInfo ( 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.

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

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.


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