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

Inheritance diagram for Lusid.Sdk.Api.IAggregationApiSync:

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

ResourceListOfAggregationQuery	GetQueryableKeys (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" that can be queried from the aggregation endpoint. More...

ApiResponse< ResourceListOfAggregationQuery >	GetQueryableKeysWithHttpInfo (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0)
	[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" 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< ListAggregationResponse >	GetValuationWithHttpInfo (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< ListAggregationResponse >	GetValuationOfWeightedInstrumentsWithHttpInfo (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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio
code	The code of the portfolio
createRecipeRequest	The request specifying the parameters to generating the recipe (optional)
operationIndex	Index 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio
code	The code of the portfolio
createRecipeRequest	The request specifying the parameters to generating the recipe (optional)
operationIndex	Index 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`
	)

[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" 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.ApiException Thrown when fails to make API call

Parameters

page	The 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)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index 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`
	)

[EARLY ACCESS] GetQueryableKeys: Query the set of supported "addresses" 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.ApiException Thrown when fails to make API call

Parameters

page	The 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)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index 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.ApiException Thrown when fails to make API call

Parameters

valuationRequest	The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndex	Index 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.ApiException Thrown when fails to make API call

Parameters

inlineValuationRequest	The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndex	Index 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.ApiException Thrown when fails to make API call

Parameters

inlineValuationRequest	The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndex	Index 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.ApiException Thrown when fails to make API call

Parameters

valuationRequest	The request specifying the set of portfolios and dates on which to calculate a set of valuation metrics (optional)
operationIndex	Index 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:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/AggregationApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GenerateConfigurationRecipe()

◆ GenerateConfigurationRecipeWithHttpInfo()

◆ GetQueryableKeys()

◆ GetQueryableKeysWithHttpInfo()

◆ GetValuation()

◆ GetValuationOfWeightedInstruments()

◆ GetValuationOfWeightedInstrumentsWithHttpInfo()

◆ GetValuationWithHttpInfo()