LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.AggregatedReturnsApi Class Reference

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

Inheritance diagram for Lusid.Sdk.Api.AggregatedReturnsApi:
Inheritance graph
[legend]

Public Member Functions

 AggregatedReturnsApi ()
 Initializes a new instance of the AggregatedReturnsApi class. More...
 
 AggregatedReturnsApi (string basePath)
 Initializes a new instance of the AggregatedReturnsApi class. More...
 
 AggregatedReturnsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the AggregatedReturnsApi class using Configuration object More...
 
 AggregatedReturnsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the AggregatedReturnsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
DeletedEntityResponse DeleteReturnsEntity (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteReturnsEntityWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteReturnsEntityAsync (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. More...
 
async 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. 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. Get returns entity. More...
 
Lusid.Sdk.Client.ApiResponse< ReturnsEntityGetReturnsEntityWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetReturnsEntity: Get returns entity. Get returns entity. More...
 
async System.Threading.Tasks.Task< ReturnsEntityGetReturnsEntityAsync (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. More...
 
async 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. Get returns entity. More...
 
ResourceListOfReturnsEntity ListReturnsEntities (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfReturnsEntityListReturnsEntitiesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities. More...
 
async System.Threading.Tasks.Task< ResourceListOfReturnsEntityListReturnsEntitiesAsync (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. More...
 
async 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. List returns entities. More...
 
ReturnsEntity UpsertReturnsEntity (ReturnsEntity returnsEntity, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity. More...
 
Lusid.Sdk.Client.ApiResponse< ReturnsEntityUpsertReturnsEntityWithHttpInfo (ReturnsEntity returnsEntity, int operationIndex=0, ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity. More...
 
async System.Threading.Tasks.Task< ReturnsEntityUpsertReturnsEntityAsync (ReturnsEntity returnsEntity, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity. More...
 
async 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. Upsert returns entity. 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ AggregatedReturnsApi() [1/4]

Lusid.Sdk.Api.AggregatedReturnsApi.AggregatedReturnsApi ( )
inline

Initializes a new instance of the AggregatedReturnsApi class.

Returns

◆ AggregatedReturnsApi() [2/4]

Lusid.Sdk.Api.AggregatedReturnsApi.AggregatedReturnsApi ( string  basePath)
inline

Initializes a new instance of the AggregatedReturnsApi class.

Returns

◆ AggregatedReturnsApi() [3/4]

Lusid.Sdk.Api.AggregatedReturnsApi.AggregatedReturnsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the AggregatedReturnsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ AggregatedReturnsApi() [4/4]

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

Initializes a new instance of the AggregatedReturnsApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ DeleteReturnsEntity()

DeletedEntityResponse Lusid.Sdk.Api.AggregatedReturnsApi.DeleteReturnsEntity ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ DeleteReturnsEntityAsync()

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

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ DeleteReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.AggregatedReturnsApi.DeleteReturnsEntityWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ DeleteReturnsEntityWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteReturnsEntity: Delete returns entity. Delete returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.AggregatedReturnsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

◆ GetReturnsEntity()

ReturnsEntity Lusid.Sdk.Api.AggregatedReturnsApi.GetReturnsEntity ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetReturnsEntity: Get returns entity. Get returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
asAtThe asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ GetReturnsEntityAsync()

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

[EXPERIMENTAL] GetReturnsEntity: Get returns entity. Get returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
asAtThe asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ GetReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ReturnsEntity> Lusid.Sdk.Api.AggregatedReturnsApi.GetReturnsEntityWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] GetReturnsEntity: Get returns entity. Get returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
asAtThe asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ GetReturnsEntityWithHttpInfoAsync()

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

[EXPERIMENTAL] GetReturnsEntity: Get returns entity. Get returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeReturns entity scope.
codeReturns entity code.
asAtThe asAt datetime at which to retrieve the returns entity. Defaults to return the latest version of the definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ReturnsEntity)

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ ListReturnsEntities()

ResourceListOfReturnsEntity Lusid.Sdk.Api.AggregatedReturnsApi.ListReturnsEntities ( DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ ListReturnsEntitiesAsync()

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

[EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ ListReturnsEntitiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfReturnsEntity> Lusid.Sdk.Api.AggregatedReturnsApi.ListReturnsEntitiesWithHttpInfo ( DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ ListReturnsEntitiesWithHttpInfoAsync()

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

[EXPERIMENTAL] ListReturnsEntities: List returns entities. List returns entities.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the relation definitions. Defaults to return the latest version of each definition if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfReturnsEntity)

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ UpsertReturnsEntity()

ReturnsEntity Lusid.Sdk.Api.AggregatedReturnsApi.UpsertReturnsEntity ( ReturnsEntity  returnsEntity,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
returnsEntityDefinition of the returns entity.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ UpsertReturnsEntityAsync()

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

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
returnsEntityDefinition of the returns entity.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

◆ UpsertReturnsEntityWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ReturnsEntity> Lusid.Sdk.Api.AggregatedReturnsApi.UpsertReturnsEntityWithHttpInfo ( ReturnsEntity  returnsEntity,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
returnsEntityDefinition of the returns entity.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ReturnsEntity

Implements Lusid.Sdk.Api.IAggregatedReturnsApiSync.

◆ UpsertReturnsEntityWithHttpInfoAsync()

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

[EXPERIMENTAL] UpsertReturnsEntity: Upsert returns entity. Upsert returns entity.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
returnsEntityDefinition of the returns entity.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ReturnsEntity)

Implements Lusid.Sdk.Api.IAggregatedReturnsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.AggregatedReturnsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AggregatedReturnsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.AggregatedReturnsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.AggregatedReturnsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


The documentation for this class was generated from the following file: