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

Inheritance diagram for Lusid.Sdk.Api.AmortisationRuleSetsApi:

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

async 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. 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< DeletedEntityResponse >	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. More...

async 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. <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< AmortisationRuleSet >	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. 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))
	[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< 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)
	[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))
	[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	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< AmortisationRuleSet >	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. 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))
	[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

configuration An 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

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The 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.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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:

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AmortisationRuleSetsApi() [1/4]

◆ AmortisationRuleSetsApi() [2/4]

◆ AmortisationRuleSetsApi() [3/4]

◆ AmortisationRuleSetsApi() [4/4]

Member Function Documentation

◆ CreateAmortisationRuleSet()

◆ CreateAmortisationRuleSetAsync()

◆ CreateAmortisationRuleSetWithHttpInfo()

◆ CreateAmortisationRuleSetWithHttpInfoAsync()

◆ DeleteAmortisationRuleset()

◆ DeleteAmortisationRulesetAsync()

◆ DeleteAmortisationRulesetWithHttpInfo()

◆ DeleteAmortisationRulesetWithHttpInfoAsync()

◆ GetAmortisationRuleSet()

◆ GetAmortisationRuleSetAsync()

◆ GetAmortisationRuleSetWithHttpInfo()

◆ GetAmortisationRuleSetWithHttpInfoAsync()

◆ GetBasePath()

◆ ListAmortisationRuleSets()

◆ ListAmortisationRuleSetsAsync()

◆ ListAmortisationRuleSetsWithHttpInfo()

◆ ListAmortisationRuleSetsWithHttpInfoAsync()

◆ UpdateAmortisationRuleSetDetails()

◆ UpdateAmortisationRuleSetDetailsAsync()

◆ UpdateAmortisationRuleSetDetailsWithHttpInfo()

◆ UpdateAmortisationRuleSetDetailsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory