LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
AggregationApi () | |
Initializes a new instance of the AggregationApi class. More... | |
AggregationApi (string basePath) | |
Initializes a new instance of the AggregationApi class. More... | |
AggregationApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the AggregationApi class using Configuration object More... | |
AggregationApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the AggregationApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
ConfigurationRecipe | GenerateConfigurationRecipe (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[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. More... | |
Lusid.Sdk.Client.ApiResponse< ConfigurationRecipe > | GenerateConfigurationRecipeWithHttpInfo (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
[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. More... | |
async System.Threading.Tasks.Task< ConfigurationRecipe > | GenerateConfigurationRecipeAsync (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ConfigurationRecipe > > | GenerateConfigurationRecipeWithHttpInfoAsync (string scope, string code, CreateRecipeRequest? createRecipeRequest=default(CreateRecipeRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
[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. More... | |
ResourceListOfAggregationQuery | GetQueryableKeys (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfAggregationQuery > | GetQueryableKeysWithHttpInfo (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< ResourceListOfAggregationQuery > | GetQueryableKeysAsync (string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null) |
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. More... | |
ListAggregationResponse | GetValuation (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
Lusid.Sdk.Client.ApiResponse< ListAggregationResponse > | GetValuationWithHttpInfo (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< ListAggregationResponse > | GetValuationAsync (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ListAggregationResponse > > | GetValuationWithHttpInfoAsync (ValuationRequest? valuationRequest=default(ValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
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. More... | |
ListAggregationResponse | GetValuationOfWeightedInstruments (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
Lusid.Sdk.Client.ApiResponse< ListAggregationResponse > | GetValuationOfWeightedInstrumentsWithHttpInfo (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< ListAggregationResponse > | GetValuationOfWeightedInstrumentsAsync (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
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. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ListAggregationResponse > > | GetValuationOfWeightedInstrumentsWithHttpInfoAsync (InlineValuationRequest? inlineValuationRequest=default(InlineValuationRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null) |
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. 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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the AggregationApi class.
|
inline |
Initializes a new instance of the AggregationApi class.
|
inline |
Initializes a new instance of the AggregationApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the AggregationApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
Gets the base path of the API client.
The base path
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
cancellationToken | Cancellation Token to cancel the request. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IAggregationApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.