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

Inheritance diagram for Lusid.Sdk.Api.IAborConfigurationApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< AborConfiguration >	CreateAborConfigurationAsync (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. More...

System.Threading.Tasks.Task< ApiResponse< AborConfiguration > >	CreateAborConfigurationWithHttpInfoAsync (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteAborConfigurationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteAborConfigurationWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. More...

System.Threading.Tasks.Task< AborConfiguration >	GetAborConfigurationAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. More...

System.Threading.Tasks.Task< ApiResponse< AborConfiguration > >	GetAborConfigurationWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. More...

System.Threading.Tasks.Task< PagedResourceListOfAborConfiguration >	ListAborConfigurationsAsync (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 >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfAborConfiguration > >	ListAborConfigurationsWithHttpInfoAsync (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 >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. More...

System.Threading.Tasks.Task< AborConfigurationProperties >	UpsertAborConfigurationPropertiesAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties More...

System.Threading.Tasks.Task< ApiResponse< AborConfigurationProperties > >	UpsertAborConfigurationPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties 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

◆ CreateAborConfigurationAsync()

System.Threading.Tasks.Task<AborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiAsync.CreateAborConfigurationAsync	(	string	scope,
		AborConfigurationRequest	aborConfigurationRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.

Create the given AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration.
aborConfigurationRequest	The definition of the AborConfiguration.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AborConfiguration

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ CreateAborConfigurationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AborConfiguration> > Lusid.Sdk.Api.IAborConfigurationApiAsync.CreateAborConfigurationWithHttpInfoAsync	(	string	scope,
		AborConfigurationRequest	aborConfigurationRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration.

Create the given AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration.
aborConfigurationRequest	The definition of the AborConfiguration.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AborConfiguration)

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ DeleteAborConfigurationAsync()

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

[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.

Delete the given AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration to be deleted.
code	The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ DeleteAborConfigurationWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration.

Delete the given AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration to be deleted.
code	The code of the AborConfiguration to be deleted. Together with the scope this uniquely identifies the AborConfiguration.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ GetAborConfigurationAsync()

System.Threading.Tasks.Task<AborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiAsync.GetAborConfigurationAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.

Retrieve the definition of a particular AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration.
code	The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.
effectiveAt	The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified. (optional)
propertyKeys	A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AborConfiguration

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ GetAborConfigurationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AborConfiguration> > Lusid.Sdk.Api.IAborConfigurationApiAsync.GetAborConfigurationWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration.

Retrieve the definition of a particular AborConfiguration.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration.
code	The code of the AborConfiguration. Together with the scope this uniquely identifies the AborConfiguration.
effectiveAt	The effective datetime or cut label at which to retrieve the AborConfiguration properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the AborConfiguration definition. Defaults to returning the latest version of the AborConfiguration definition if not specified. (optional)
propertyKeys	A list of property keys from the 'AborConfiguration' domain to decorate onto the AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. If no properties are specified, then no properties will be returned. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AborConfiguration)

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ ListAborConfigurationsAsync()

System.Threading.Tasks.Task<PagedResourceListOfAborConfiguration> Lusid.Sdk.Api.IAborConfigurationApiAsync.ListAborConfigurationsAsync	(	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 >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.

List all the AborConfiguration matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified. (optional)
page	The pagination token to use to continue listing AborConfiguration; 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 example, to filter on the AborConfiguration type, specify "id.Code eq 'AborConfiguration1'". 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)
propertyKeys	A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfAborConfiguration

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ ListAborConfigurationsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfAborConfiguration> > Lusid.Sdk.Api.IAborConfigurationApiAsync.ListAborConfigurationsWithHttpInfoAsync	(	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 >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration.

List all the AborConfiguration matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the TimeVariant properties for the AborConfiguration. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the AborConfiguration. Defaults to returning the latest version of each AAborConfigurationbor if not specified. (optional)
page	The pagination token to use to continue listing AborConfiguration; 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 example, to filter on the AborConfiguration type, specify "id.Code eq 'AborConfiguration1'". 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)
propertyKeys	A list of property keys from the 'AborConfiguration' domain to decorate onto each AborConfiguration. These must take the format {domain}/{scope}/{code}, for example 'AborConfiguration/Manager/Id'. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfAborConfiguration)

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ UpsertAborConfigurationPropertiesAsync()

System.Threading.Tasks.Task<AborConfigurationProperties> Lusid.Sdk.Api.IAborConfigurationApiAsync.UpsertAborConfigurationPropertiesAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties

Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration to update or insert the properties onto.
code	The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.
requestBody	The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "AborConfiguration/Manager/Id". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AborConfigurationProperties

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

◆ UpsertAborConfigurationPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AborConfigurationProperties> > Lusid.Sdk.Api.IAborConfigurationApiAsync.UpsertAborConfigurationPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary< string, Property >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertAborConfigurationProperties: Upsert AborConfiguration properties

Update or insert one or more properties onto a single AborConfiguration. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'AborConfiguration'. Upserting a property that exists for an AborConfiguration, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the AborConfiguration to update or insert the properties onto.
code	The code of the AborConfiguration to update or insert the properties onto. Together with the scope this uniquely identifies the AborConfiguration.
requestBody	The properties to be updated or inserted onto the chart of account. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "AborConfiguration/Manager/Id". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AborConfigurationProperties)

Implemented in Lusid.Sdk.Api.AborConfigurationApi.

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/AborConfigurationApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateAborConfigurationAsync()

◆ CreateAborConfigurationWithHttpInfoAsync()

◆ DeleteAborConfigurationAsync()

◆ DeleteAborConfigurationWithHttpInfoAsync()

◆ GetAborConfigurationAsync()

◆ GetAborConfigurationWithHttpInfoAsync()

◆ ListAborConfigurationsAsync()

◆ ListAborConfigurationsWithHttpInfoAsync()

◆ UpsertAborConfigurationPropertiesAsync()

◆ UpsertAborConfigurationPropertiesWithHttpInfoAsync()