LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IAggregationApiAsync Interface Reference

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

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

Public Member Functions

System.Threading.Tasks.Task< ConfigurationRecipeGenerateConfigurationRecipeAsync (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. More...
 
System.Threading.Tasks.Task< ApiResponse< ConfigurationRecipe > > GenerateConfigurationRecipeWithHttpInfoAsync (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. More...
 
System.Threading.Tasks.Task< ResourceListOfAggregationQueryGetQueryableKeysAsync (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint. More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfAggregationQuery > > GetQueryableKeysWithHttpInfoAsync (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint. More...
 
System.Threading.Tasks.Task< ListAggregationResponseGetValuationAsync (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetValuation: Perform valuation for a list of portfolios and/or portfolio groups More...
 
System.Threading.Tasks.Task< ApiResponse< ListAggregationResponse > > GetValuationWithHttpInfoAsync (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetValuation: Perform valuation for a list of portfolios and/or portfolio groups More...
 
System.Threading.Tasks.Task< ListAggregationResponseGetValuationOfWeightedInstrumentsAsync (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio More...
 
System.Threading.Tasks.Task< ApiResponse< ListAggregationResponse > > GetValuationOfWeightedInstrumentsWithHttpInfoAsync (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- 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

Member Function Documentation

◆ GenerateConfigurationRecipeAsync()

System.Threading.Tasks.Task<ConfigurationRecipe> Lusid.Sdk.Api.IAggregationApiAsync.GenerateConfigurationRecipeAsync ( string  scope,
string  code,
CreateRecipeRequest createRecipeRequest = default(CreateRecipeRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.

Given a set of scopes, a portfolio Id and a basic recipe, this endpoint generates a configuration recipe with relevant rules that can value the instruments in the portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio
codeThe code of the portfolio
createRecipeRequestThe request specifying the parameters to generating the recipe (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ConfigurationRecipe

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GenerateConfigurationRecipeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ConfigurationRecipe> > Lusid.Sdk.Api.IAggregationApiAsync.GenerateConfigurationRecipeWithHttpInfoAsync ( string  scope,
string  code,
CreateRecipeRequest createRecipeRequest = default(CreateRecipeRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio.

Given a set of scopes, a portfolio Id and a basic recipe, this endpoint generates a configuration recipe with relevant rules that can value the instruments in the portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio
codeThe code of the portfolio
createRecipeRequestThe request specifying the parameters to generating the recipe (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ConfigurationRecipe)

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetQueryableKeysAsync()

System.Threading.Tasks.Task<ResourceListOfAggregationQuery> Lusid.Sdk.Api.IAggregationApiAsync.GetQueryableKeysAsync ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint.

When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAggregationQuery

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetQueryableKeysWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAggregationQuery> > Lusid.Sdk.Api.IAggregationApiAsync.GetQueryableKeysWithHttpInfoAsync ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint.

When a request is made for aggregation, the user needs to know what keys can be passed to it for queryable data. This endpoint allows to queries to provide the set of keys, what they are and what they return.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
pageThe pagination token to use to continue listing queryable keys from a previous call to list queryable keys. This value is returned from the previous call. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAggregationQuery)

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationAsync()

System.Threading.Tasks.Task<ListAggregationResponse> Lusid.Sdk.Api.IAggregationApiAsync.GetValuationAsync ( ValuationRequest valuationRequest = default(ValuationRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetValuation: Perform valuation for a list of portfolios and/or portfolio groups

Perform valuation on specified list of portfolio and/or portfolio groups for a set of dates.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
valuationRequestThe request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationOfWeightedInstrumentsAsync()

System.Threading.Tasks.Task<ListAggregationResponse> Lusid.Sdk.Api.IAggregationApiAsync.GetValuationOfWeightedInstrumentsAsync ( InlineValuationRequest inlineValuationRequest = default(InlineValuationRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio

Perform valuation on the portfolio that is defined by the weighted set of instruments passed to the request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
inlineValuationRequestThe request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationOfWeightedInstrumentsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ListAggregationResponse> > Lusid.Sdk.Api.IAggregationApiAsync.GetValuationOfWeightedInstrumentsWithHttpInfoAsync ( InlineValuationRequest inlineValuationRequest = default(InlineValuationRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio

Perform valuation on the portfolio that is defined by the weighted set of instruments passed to the request.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
inlineValuationRequestThe request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ListAggregationResponse)

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ListAggregationResponse> > Lusid.Sdk.Api.IAggregationApiAsync.GetValuationWithHttpInfoAsync ( ValuationRequest valuationRequest = default(ValuationRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

GetValuation: Perform valuation for a list of portfolios and/or portfolio groups

Perform valuation on specified list of portfolio and/or portfolio groups for a set of dates.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
valuationRequestThe request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ListAggregationResponse)

Implemented in Lusid.Sdk.Api.AggregationApi.


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