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

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

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

Public Member Functions

ConfigurationRecipe GenerateConfigurationRecipe (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0)
 [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. More...
 
ApiResponse< ConfigurationRecipeGenerateConfigurationRecipeWithHttpInfo (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0)
 [EXPERIMENTAL] GenerateConfigurationRecipe: Generates a recipe sufficient to perform valuations for the given portfolio. More...
 
ResourceListOfAggregationQuery GetQueryableKeys (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint. More...
 
ApiResponse< ResourceListOfAggregationQueryGetQueryableKeysWithHttpInfo (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
 GetQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from the aggregation endpoint. More...
 
ListAggregationResponse GetValuation (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0)
 GetValuation: Perform valuation for a list of portfolios and/or portfolio groups More...
 
ApiResponse< ListAggregationResponseGetValuationWithHttpInfo (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0)
 GetValuation: Perform valuation for a list of portfolios and/or portfolio groups More...
 
ListAggregationResponse GetValuationOfWeightedInstruments (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0)
 GetValuationOfWeightedInstruments: Perform valuation for an inlined portfolio More...
 
ApiResponse< ListAggregationResponseGetValuationOfWeightedInstrumentsWithHttpInfo (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0)
 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

◆ GenerateConfigurationRecipe()

ConfigurationRecipe Lusid.Sdk.Api.IAggregationApiSync.GenerateConfigurationRecipe ( string  scope,
string  code,
CreateRecipeRequest createRecipeRequest = default(CreateRecipeRequest?),
int  operationIndex = 0 
)

[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.
Returns
ConfigurationRecipe

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GenerateConfigurationRecipeWithHttpInfo()

ApiResponse<ConfigurationRecipe> Lusid.Sdk.Api.IAggregationApiSync.GenerateConfigurationRecipeWithHttpInfo ( string  scope,
string  code,
CreateRecipeRequest createRecipeRequest = default(CreateRecipeRequest?),
int  operationIndex = 0 
)

[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.
Returns
ApiResponse of ConfigurationRecipe

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetQueryableKeys()

ResourceListOfAggregationQuery Lusid.Sdk.Api.IAggregationApiSync.GetQueryableKeys ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

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.
Returns
ResourceListOfAggregationQuery

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetQueryableKeysWithHttpInfo()

ApiResponse<ResourceListOfAggregationQuery> Lusid.Sdk.Api.IAggregationApiSync.GetQueryableKeysWithHttpInfo ( string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
int  operationIndex = 0 
)

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.
Returns
ApiResponse of ResourceListOfAggregationQuery

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuation()

ListAggregationResponse Lusid.Sdk.Api.IAggregationApiSync.GetValuation ( ValuationRequest valuationRequest = default(ValuationRequest?),
int  operationIndex = 0 
)

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.
Returns
ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationOfWeightedInstruments()

ListAggregationResponse Lusid.Sdk.Api.IAggregationApiSync.GetValuationOfWeightedInstruments ( InlineValuationRequest inlineValuationRequest = default(InlineValuationRequest?),
int  operationIndex = 0 
)

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.
Returns
ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationOfWeightedInstrumentsWithHttpInfo()

ApiResponse<ListAggregationResponse> Lusid.Sdk.Api.IAggregationApiSync.GetValuationOfWeightedInstrumentsWithHttpInfo ( InlineValuationRequest inlineValuationRequest = default(InlineValuationRequest?),
int  operationIndex = 0 
)

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.
Returns
ApiResponse of ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.

◆ GetValuationWithHttpInfo()

ApiResponse<ListAggregationResponse> Lusid.Sdk.Api.IAggregationApiSync.GetValuationWithHttpInfo ( ValuationRequest valuationRequest = default(ValuationRequest?),
int  operationIndex = 0 
)

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.
Returns
ApiResponse of ListAggregationResponse

Implemented in Lusid.Sdk.Api.AggregationApi.


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