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

Inheritance diagram for Lusid.Sdk.Api.AborConfigurationApi:

[legend]

Public Member Functions
	AborConfigurationApi ()
	Initializes a new instance of the AborConfigurationApi class. More...

	AborConfigurationApi (string basePath)
	Initializes a new instance of the AborConfigurationApi class. More...

	AborConfigurationApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the AborConfigurationApi class using Configuration object More...

	AborConfigurationApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the AborConfigurationApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

AborConfiguration	CreateAborConfiguration (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. Create the given AborConfiguration. More...

Lusid.Sdk.Client.ApiResponse< AborConfiguration >	CreateAborConfigurationWithHttpInfo (string scope, AborConfigurationRequest aborConfigurationRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateAborConfiguration: Create an AborConfiguration. Create the given AborConfiguration. More...

async 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. Create the given AborConfiguration. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AborConfiguration > >	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. More...

DeletedEntityResponse	DeleteAborConfiguration (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. Delete the given AborConfiguration. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteAborConfigurationWithHttpInfo (string scope, string code, int operationIndex=0)
	[EXPERIMENTAL] DeleteAborConfiguration: Delete an AborConfiguration. Delete the given AborConfiguration. More...

async 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. Delete the given AborConfiguration. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	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. More...

AborConfiguration	GetAborConfiguration (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. Retrieve the definition of a particular AborConfiguration. More...

Lusid.Sdk.Client.ApiResponse< AborConfiguration >	GetAborConfigurationWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetAborConfiguration: Get AborConfiguration. Retrieve the definition of a particular AborConfiguration. More...

async 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. Retrieve the definition of a particular AborConfiguration. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Retrieve the definition of a particular AborConfiguration. More...

PagedResourceListOfAborConfiguration	ListAborConfigurations (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)
	[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. List all the AborConfiguration matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAborConfiguration >	ListAborConfigurationsWithHttpInfo (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)
	[EXPERIMENTAL] ListAborConfigurations: List AborConfiguration. List all the AborConfiguration matching particular criteria. More...

async 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. List all the AborConfiguration matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. List all the AborConfiguration matching particular criteria. More...

AborConfigurationProperties	UpsertAborConfigurationProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
	[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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

Lusid.Sdk.Client.ApiResponse< AborConfigurationProperties >	UpsertAborConfigurationPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
	[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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async 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 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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. 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

◆ AborConfigurationApi() [1/4]

Lusid.Sdk.Api.AborConfigurationApi.AborConfigurationApi ( )

inline

Initializes a new instance of the AborConfigurationApi class.

Returns

◆ AborConfigurationApi() [2/4]

Lusid.Sdk.Api.AborConfigurationApi.AborConfigurationApi ( string basePath )

inline

Initializes a new instance of the AborConfigurationApi class.

Returns

◆ AborConfigurationApi() [3/4]

Lusid.Sdk.Api.AborConfigurationApi.AborConfigurationApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the AborConfigurationApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ AborConfigurationApi() [4/4]

Lusid.Sdk.Api.AborConfigurationApi.AborConfigurationApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the AborConfigurationApi 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

◆ CreateAborConfiguration()

AborConfiguration Lusid.Sdk.Api.AborConfigurationApi.CreateAborConfiguration	(	string	scope,
		AborConfigurationRequest	aborConfigurationRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: AborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ CreateAborConfigurationAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ CreateAborConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AborConfiguration> Lusid.Sdk.Api.AborConfigurationApi.CreateAborConfigurationWithHttpInfo	(	string	scope,
		AborConfigurationRequest	aborConfigurationRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of AborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ CreateAborConfigurationWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ DeleteAborConfiguration()

DeletedEntityResponse Lusid.Sdk.Api.AborConfigurationApi.DeleteAborConfiguration	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

inline

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

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ DeleteAborConfigurationAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ DeleteAborConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.AborConfigurationApi.DeleteAborConfigurationWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ DeleteAborConfigurationWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ GetAborConfiguration()

AborConfiguration Lusid.Sdk.Api.AborConfigurationApi.GetAborConfiguration	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: AborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ GetAborConfigurationAsync()

async System.Threading.Tasks.Task<AborConfiguration> Lusid.Sdk.Api.AborConfigurationApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ GetAborConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AborConfiguration> Lusid.Sdk.Api.AborConfigurationApi.GetAborConfigurationWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of AborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ GetAborConfigurationWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AborConfiguration> > Lusid.Sdk.Api.AborConfigurationApi.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)`
	)

inline

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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.AborConfigurationApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ ListAborConfigurations()

PagedResourceListOfAborConfiguration Lusid.Sdk.Api.AborConfigurationApi.ListAborConfigurations	(	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`
	)

inline

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

Returns: PagedResourceListOfAborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ ListAborConfigurationsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfAborConfiguration> Lusid.Sdk.Api.AborConfigurationApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ ListAborConfigurationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAborConfiguration> Lusid.Sdk.Api.AborConfigurationApi.ListAborConfigurationsWithHttpInfo	(	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`
	)

inline

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

Returns: ApiResponse of PagedResourceListOfAborConfiguration

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ ListAborConfigurationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAborConfiguration> > Lusid.Sdk.Api.AborConfigurationApi.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)`
	)

inline

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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ UpsertAborConfigurationProperties()

AborConfigurationProperties Lusid.Sdk.Api.AborConfigurationApi.UpsertAborConfigurationProperties	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary<string, Property>?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: AborConfigurationProperties

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ UpsertAborConfigurationPropertiesAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

◆ UpsertAborConfigurationPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AborConfigurationProperties> Lusid.Sdk.Api.AborConfigurationApi.UpsertAborConfigurationPropertiesWithHttpInfo	(	string	scope,
		string	code,
		Dictionary< string, Property >?	requestBody = `default(Dictionary<string, Property>?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of AborConfigurationProperties

Implements Lusid.Sdk.Api.IAborConfigurationApiSync.

◆ UpsertAborConfigurationPropertiesWithHttpInfoAsync()

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

inline

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

Implements Lusid.Sdk.Api.IAborConfigurationApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.AborConfigurationApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AborConfigurationApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.AborConfigurationApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.AborConfigurationApi.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/AborConfigurationApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AborConfigurationApi() [1/4]

◆ AborConfigurationApi() [2/4]

◆ AborConfigurationApi() [3/4]

◆ AborConfigurationApi() [4/4]

Member Function Documentation

◆ CreateAborConfiguration()

◆ CreateAborConfigurationAsync()

◆ CreateAborConfigurationWithHttpInfo()

◆ CreateAborConfigurationWithHttpInfoAsync()

◆ DeleteAborConfiguration()

◆ DeleteAborConfigurationAsync()

◆ DeleteAborConfigurationWithHttpInfo()

◆ DeleteAborConfigurationWithHttpInfoAsync()

◆ GetAborConfiguration()

◆ GetAborConfigurationAsync()

◆ GetAborConfigurationWithHttpInfo()

◆ GetAborConfigurationWithHttpInfoAsync()

◆ GetBasePath()

◆ ListAborConfigurations()

◆ ListAborConfigurationsAsync()

◆ ListAborConfigurationsWithHttpInfo()

◆ ListAborConfigurationsWithHttpInfoAsync()

◆ UpsertAborConfigurationProperties()

◆ UpsertAborConfigurationPropertiesAsync()

◆ UpsertAborConfigurationPropertiesWithHttpInfo()

◆ UpsertAborConfigurationPropertiesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory