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

Inheritance diagram for Lusid.Sdk.Api.IAggregatedReturnsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteReturnsEntityAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteReturnsEntityWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. More...

System.Threading.Tasks.Task< ReturnsEntity >	GetReturnsEntityAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetReturnsEntity: Get returns entity. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ReturnsEntity > >	GetReturnsEntityWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetReturnsEntity: Get returns entity. More...

System.Threading.Tasks.Task< ResourceListOfReturnsEntity >	ListReturnsEntitiesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListReturnsEntities: List returns entities. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfReturnsEntity > >	ListReturnsEntitiesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListReturnsEntities: List returns entities. More...

System.Threading.Tasks.Task< ReturnsEntity >	UpsertReturnsEntityAsync (ReturnsEntity returnsEntity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ReturnsEntity > >	UpsertReturnsEntityWithHttpInfoAsync (ReturnsEntity returnsEntity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteReturnsEntityAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IAggregatedReturnsApiAsync.DeleteReturnsEntityAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity.

Delete returns entity.

Exceptions

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

Parameters

scope	Returns entity scope.
code	Returns entity code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ DeleteReturnsEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IAggregatedReturnsApiAsync.DeleteReturnsEntityWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity.

Delete returns entity.

Exceptions

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

Parameters

scope	Returns entity scope.
code	Returns entity code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ GetReturnsEntityAsync()

System.Threading.Tasks.Task<ReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiAsync.GetReturnsEntityAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetReturnsEntity: Get returns entity.

Get returns entity.

Exceptions

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

Parameters

scope	Returns entity scope.
code	Returns entity code.
asAt	The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ GetReturnsEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ReturnsEntity> > Lusid.Sdk.Api.IAggregatedReturnsApiAsync.GetReturnsEntityWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] GetReturnsEntity: Get returns entity.

Get returns entity.

Exceptions

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

Parameters

scope	Returns entity scope.
code	Returns entity code.
asAt	The asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ReturnsEntity)

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ ListReturnsEntitiesAsync()

System.Threading.Tasks.Task<ResourceListOfReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiAsync.ListReturnsEntitiesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListReturnsEntities: List returns entities.

List returns entities.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ ListReturnsEntitiesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfReturnsEntity> > Lusid.Sdk.Api.IAggregatedReturnsApiAsync.ListReturnsEntitiesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] ListReturnsEntities: List returns entities.

List returns entities.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfReturnsEntity)

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ UpsertReturnsEntityAsync()

System.Threading.Tasks.Task<ReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiAsync.UpsertReturnsEntityAsync	(	ReturnsEntity	returnsEntity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity.

Upsert returns entity.

Exceptions

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

Parameters

returnsEntity	Definition of the returns entity.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ UpsertReturnsEntityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ReturnsEntity> > Lusid.Sdk.Api.IAggregatedReturnsApiAsync.UpsertReturnsEntityWithHttpInfoAsync	(	ReturnsEntity	returnsEntity,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity.

Upsert returns entity.

Exceptions

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

Parameters

returnsEntity	Definition of the returns entity.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ReturnsEntity)

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteReturnsEntityAsync()

◆ DeleteReturnsEntityWithHttpInfoAsync()

◆ GetReturnsEntityAsync()

◆ GetReturnsEntityWithHttpInfoAsync()

◆ ListReturnsEntitiesAsync()

◆ ListReturnsEntitiesWithHttpInfoAsync()

◆ UpsertReturnsEntityAsync()

◆ UpsertReturnsEntityWithHttpInfoAsync()