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

Inheritance diagram for Lusid.Sdk.Api.IAggregatedReturnsApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteReturnsEntity (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteReturnsEntityWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. More...

ReturnsEntity	GetReturnsEntity (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetReturnsEntity: Get returns entity. More...

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

ResourceListOfReturnsEntity	ListReturnsEntities (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListReturnsEntities: List returns entities. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfReturnsEntity >	ListReturnsEntitiesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListReturnsEntities: List returns entities. More...

ReturnsEntity	UpsertReturnsEntity (ReturnsEntity returnsEntity, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. More...

Lusid.Sdk.Client.ApiResponse< ReturnsEntity >	UpsertReturnsEntityWithHttpInfo (ReturnsEntity returnsEntity, int operationIndex=0, 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

◆ DeleteReturnsEntity()

DeletedEntityResponse Lusid.Sdk.Api.IAggregatedReturnsApiSync.DeleteReturnsEntity	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ DeleteReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IAggregatedReturnsApiSync.DeleteReturnsEntityWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ GetReturnsEntity()

ReturnsEntity Lusid.Sdk.Api.IAggregatedReturnsApiSync.GetReturnsEntity	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ GetReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiSync.GetReturnsEntityWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of ReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ ListReturnsEntities()

ResourceListOfReturnsEntity Lusid.Sdk.Api.IAggregatedReturnsApiSync.ListReturnsEntities	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ResourceListOfReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ ListReturnsEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiSync.ListReturnsEntitiesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ UpsertReturnsEntity()

ReturnsEntity Lusid.Sdk.Api.IAggregatedReturnsApiSync.UpsertReturnsEntity	(	ReturnsEntity	returnsEntity,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ReturnsEntity

Implemented in Lusid.Sdk.Api.AggregatedReturnsApi.

◆ UpsertReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ReturnsEntity> Lusid.Sdk.Api.IAggregatedReturnsApiSync.UpsertReturnsEntityWithHttpInfo	(	ReturnsEntity	returnsEntity,
		int	operationIndex = `0`,
		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.
opts	Options for this request.

Returns: ApiResponse of 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

◆ DeleteReturnsEntity()

◆ DeleteReturnsEntityWithHttpInfo()

◆ GetReturnsEntity()

◆ GetReturnsEntityWithHttpInfo()

◆ ListReturnsEntities()

◆ ListReturnsEntitiesWithHttpInfo()

◆ UpsertReturnsEntity()

◆ UpsertReturnsEntityWithHttpInfo()