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

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

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

Public Member Functions

 EntitiesApi ()
 Initializes a new instance of the EntitiesApi class. More...
 
 EntitiesApi (string basePath)
 Initializes a new instance of the EntitiesApi class. More...
 
 EntitiesApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the EntitiesApi class using Configuration object More...
 
 EntitiesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the EntitiesApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
PortfolioEntity GetPortfolioByEntityUniqueId (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioEntityGetPortfolioByEntityUniqueIdWithHttpInfo (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...
 
async System.Threading.Tasks.Task< PortfolioEntityGetPortfolioByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioEntity > > GetPortfolioByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? previews=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion. More...
 
ResourceListOfChange GetPortfolioChanges (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfChangeGetPortfolioChangesWithHttpInfo (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...
 
async System.Threading.Tasks.Task< ResourceListOfChangeGetPortfolioChangesAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfChange > > GetPortfolioChangesWithHttpInfoAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). 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

◆ EntitiesApi() [1/4]

Lusid.Sdk.Api.EntitiesApi.EntitiesApi ( )
inline

Initializes a new instance of the EntitiesApi class.

Returns

◆ EntitiesApi() [2/4]

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

Initializes a new instance of the EntitiesApi class.

Returns

◆ EntitiesApi() [3/4]

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

Initializes a new instance of the EntitiesApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ EntitiesApi() [4/4]

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

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

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetPortfolioByEntityUniqueId()

PortfolioEntity Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueId ( string  entityUniqueId,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  previews = default(List<string>?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioByEntityUniqueIdAsync()

async System.Threading.Tasks.Task<PortfolioEntity> Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdAsync ( string  entityUniqueId,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  previews = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioByEntityUniqueIdWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioEntity> Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdWithHttpInfo ( string  entityUniqueId,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  previews = default(List<string>?),
int  operationIndex = 0 
)
inline

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioEntity

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PortfolioEntity> > Lusid.Sdk.Api.EntitiesApi.GetPortfolioByEntityUniqueIdWithHttpInfoAsync ( string  entityUniqueId,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  previews = default(List<string>?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
entityUniqueIdThe universally unique identifier of the portfolio definition.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
previewsThe ids of the staged modifications to be previewed in the response. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioEntity)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioChanges()

ResourceListOfChange Lusid.Sdk.Api.EntitiesApi.GetPortfolioChanges ( string  scope,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioChangesAsync()

async System.Threading.Tasks.Task<ResourceListOfChange> Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesAsync ( string  scope,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

◆ GetPortfolioChangesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfChange> Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesWithHttpInfo ( string  scope,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfChange

Implements Lusid.Sdk.Api.IEntitiesApiSync.

◆ GetPortfolioChangesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfChange> > Lusid.Sdk.Api.EntitiesApi.GetPortfolioChangesWithHttpInfoAsync ( string  scope,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

GetPortfolioChanges: Get the next change to each portfolio in a scope. Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope
effectiveAtThe effective date of the origin.
asAtThe as-at date of the origin. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfChange)

Implements Lusid.Sdk.Api.IEntitiesApiAsync.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.EntitiesApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.EntitiesApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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