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

Inheritance diagram for Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< AmortisationRuleSet >	CreateAmortisationRuleSetAsync (string scope, CreateAmortisationRuleSetRequest createAmortisationRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateAmortisationRuleSet: Create an amortisation rule set. More...

System.Threading.Tasks.Task< 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. More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteAmortisationRulesetAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteAmortisationRuleset: Delete an amortisation rule set. More...

System.Threading.Tasks.Task< 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. More...

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))
	[EXPERIMENTAL] GetAmortisationRuleSet: Retrieve the definition of a single amortisation rule set More...

System.Threading.Tasks.Task< 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 More...

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))
	[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets. More...

System.Threading.Tasks.Task< 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. More...

System.Threading.Tasks.Task< AmortisationRuleSet >	UpdateAmortisationRuleSetDetailsAsync (string scope, string code, UpdateAmortisationRuleSetDetailsRequest updateAmortisationRuleSetDetailsRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpdateAmortisationRuleSetDetails: Update an amortisation rule set. More...

System.Threading.Tasks.Task< 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. 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

◆ CreateAmortisationRuleSetAsync()

System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.CreateAmortisationRuleSetAsync	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of AmortisationRuleSet

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ CreateAmortisationRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of ApiResponse (AmortisationRuleSet)

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ DeleteAmortisationRulesetAsync()

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

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ DeleteAmortisationRulesetWithHttpInfoAsync()

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

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ GetAmortisationRuleSetAsync()

System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.GetAmortisationRuleSetAsync	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of AmortisationRuleSet

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ GetAmortisationRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of ApiResponse (AmortisationRuleSet)

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ ListAmortisationRuleSetsAsync()

System.Threading.Tasks.Task<PagedResourceListOfAmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.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)`
	)

[EXPERIMENTAL] ListAmortisationRuleSets: List amortisation rule sets.

Retrieves all amortisation rule sets at the given effective and as at times

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of PagedResourceListOfAmortisationRuleSet

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ ListAmortisationRuleSetsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfAmortisationRuleSet> > Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of ApiResponse (PagedResourceListOfAmortisationRuleSet)

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ UpdateAmortisationRuleSetDetailsAsync()

System.Threading.Tasks.Task<AmortisationRuleSet> Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.UpdateAmortisationRuleSetDetailsAsync	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of AmortisationRuleSet

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

◆ UpdateAmortisationRuleSetDetailsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AmortisationRuleSet> > Lusid.Sdk.Api.IAmortisationRuleSetsApiAsync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

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.

Returns: Task of ApiResponse (AmortisationRuleSet)

Implemented in Lusid.Sdk.Api.AmortisationRuleSetsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/AmortisationRuleSetsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateAmortisationRuleSetAsync()

◆ CreateAmortisationRuleSetWithHttpInfoAsync()

◆ DeleteAmortisationRulesetAsync()

◆ DeleteAmortisationRulesetWithHttpInfoAsync()

◆ GetAmortisationRuleSetAsync()

◆ GetAmortisationRuleSetWithHttpInfoAsync()

◆ ListAmortisationRuleSetsAsync()

◆ ListAmortisationRuleSetsWithHttpInfoAsync()

◆ UpdateAmortisationRuleSetDetailsAsync()

◆ UpdateAmortisationRuleSetDetailsWithHttpInfoAsync()