sdk.lusid.api.configuration_recipe_api.ConfigurationRecipeApi

class ConfigurationRecipeApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

`delete_configuration_recipe`	DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.
`delete_configuration_recipe_with_http_info`	DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present.
`delete_recipe_composer`	[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present.
`delete_recipe_composer_with_http_info`	[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present.
`get_configuration_recipe`	GetConfigurationRecipe: Get Configuration Recipe # noqa: E501
`get_configuration_recipe_with_http_info`	GetConfigurationRecipe: Get Configuration Recipe # noqa: E501
`get_derived_recipe`	[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer.
`get_derived_recipe_with_http_info`	[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer.
`get_recipe_composer`	[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer # noqa: E501
`get_recipe_composer_resolved_inline`	[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence.
`get_recipe_composer_resolved_inline_with_http_info`	[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence.
`get_recipe_composer_with_http_info`	[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer # noqa: E501
`list_configuration_recipes`	ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
`list_configuration_recipes_with_http_info`	ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
`list_derived_recipes`	[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers.
`list_derived_recipes_with_http_info`	[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers.
`list_recipe_composers`	[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers # noqa: E501
`list_recipe_composers_with_http_info`	[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers # noqa: E501
`upsert_configuration_recipe`	UpsertConfigurationRecipe: Upsert a Configuration Recipe.
`upsert_configuration_recipe_with_http_info`	UpsertConfigurationRecipe: Upsert a Configuration Recipe.
`upsert_recipe_composer`	[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer.
`upsert_recipe_composer_with_http_info`	[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer.

delete_configuration_recipe(scope, code, async_req=None, **kwargs)[source]

DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. # noqa: E501

Delete the specified Configuration Recipe from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_configuration_recipe(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe to delete. (required)
code (str) – The Configuration Recipe to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AnnulSingleStructuredDataResponse

delete_configuration_recipe_with_http_info(scope, code, **kwargs)[source]

DeleteConfigurationRecipe: Delete a Configuration Recipe, assuming that it is present. # noqa: E501

Delete the specified Configuration Recipe from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_configuration_recipe_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe to delete. (required)
code (str) – The Configuration Recipe to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

delete_recipe_composer(scope, code, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. # noqa: E501

Delete the specified Recipe Composer from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_recipe_composer(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Recipe Composer to delete. (required)
code (str) – The Recipe Composer to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AnnulSingleStructuredDataResponse

delete_recipe_composer_with_http_info(scope, code, **kwargs)[source]

[EXPERIMENTAL] DeleteRecipeComposer: Delete a Recipe Composer, assuming that it is present. # noqa: E501

Delete the specified Recipe Composer from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. It is important to always check for any unsuccessful response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_recipe_composer_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Recipe Composer to delete. (required)
code (str) – The Recipe Composer to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

get_configuration_recipe(scope, code, as_at=None, async_req=None, **kwargs)[source]

GetConfigurationRecipe: Get Configuration Recipe # noqa: E501

Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_configuration_recipe(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe to retrieve. (required)
code (str) – The name of the recipe to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetRecipeResponse

get_configuration_recipe_with_http_info(scope, code, as_at=None, **kwargs)[source]

GetConfigurationRecipe: Get Configuration Recipe # noqa: E501

Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_configuration_recipe_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe to retrieve. (required)
code (str) – The name of the recipe to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(GetRecipeResponse, status_code(int), headers(HTTPHeaderDict))

get_derived_recipe(scope, code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501

If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_derived_recipe(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe or Recipe Composer to return. (required)
code (str) – The code of the Configuration Recipe or Recipe Composer to return. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetRecipeResponse

get_derived_recipe_with_http_info(scope, code, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501

If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_derived_recipe_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Configuration Recipe or Recipe Composer to return. (required)
code (str) – The code of the Configuration Recipe or Recipe Composer to return. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(GetRecipeResponse, status_code(int), headers(HTTPHeaderDict))

get_recipe_composer(scope, code, as_at=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer # noqa: E501

Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_recipe_composer(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Recipe Composer to retrieve. (required)
code (str) – The name of the Recipe Composer to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetRecipeComposerResponse

get_recipe_composer_resolved_inline(upsert_recipe_composer_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. # noqa: E501

Resolves an inline recipe composer into a ConfigurationRecipe. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_recipe_composer_resolved_inline(upsert_recipe_composer_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_composer_request (UpsertRecipeComposerRequest) – Recipe composer used to expand into the Configuration Recipe. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetRecipeResponse

get_recipe_composer_resolved_inline_with_http_info(upsert_recipe_composer_request, **kwargs)[source]

[EXPERIMENTAL] GetRecipeComposerResolvedInline: Given a Recipe Composer, this endpoint expands into a Configuration Recipe without persistence. Primarily used for testing purposes. # noqa: E501

Resolves an inline recipe composer into a ConfigurationRecipe. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_recipe_composer_resolved_inline_with_http_info(upsert_recipe_composer_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_composer_request (UpsertRecipeComposerRequest) – Recipe composer used to expand into the Configuration Recipe. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(GetRecipeResponse, status_code(int), headers(HTTPHeaderDict))

get_recipe_composer_with_http_info(scope, code, as_at=None, **kwargs)[source]

[EXPERIMENTAL] GetRecipeComposer: Get Recipe Composer # noqa: E501

Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_recipe_composer_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Recipe Composer to retrieve. (required)
code (str) – The name of the Recipe Composer to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(GetRecipeComposerResponse, status_code(int), headers(HTTPHeaderDict))

list_configuration_recipes(as_at=None, filter=None, async_req=None, **kwargs)[source]

ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501

List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_configuration_recipes(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfGetRecipeResponse

list_configuration_recipes_with_http_info(as_at=None, filter=None, **kwargs)[source]

ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501

List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_configuration_recipes_with_http_info(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfGetRecipeResponse, status_code(int), headers(HTTPHeaderDict))

list_derived_recipes(as_at=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501

This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_derived_recipes(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
filter (str) – Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfGetRecipeResponse

list_derived_recipes_with_http_info(as_at=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501

This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_derived_recipes_with_http_info(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
filter (str) – Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfGetRecipeResponse, status_code(int), headers(HTTPHeaderDict))

list_recipe_composers(as_at=None, filter=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers # noqa: E501

List the set of Recipe Composers at the specified date/time and scope # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_recipe_composers(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
filter (str) – Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfGetRecipeComposerResponse

list_recipe_composers_with_http_info(as_at=None, filter=None, **kwargs)[source]

[EXPERIMENTAL] ListRecipeComposers: List the set of Recipe Composers # noqa: E501

List the set of Recipe Composers at the specified date/time and scope # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_recipe_composers_with_http_info(as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

as_at (datetime) – The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
filter (str) – Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfGetRecipeComposerResponse, status_code(int), headers(HTTPHeaderDict))

upsert_configuration_recipe(upsert_recipe_request, async_req=None, **kwargs)[source]

UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. # noqa: E501

Update or insert one Configuration Recipe in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Configuration Recipe or failure message if unsuccessful It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_configuration_recipe(upsert_recipe_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_request (UpsertRecipeRequest) – The Configuration Recipe to update or insert (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UpsertSingleStructuredDataResponse

upsert_configuration_recipe_with_http_info(upsert_recipe_request, **kwargs)[source]

UpsertConfigurationRecipe: Upsert a Configuration Recipe. This creates or updates the data in Lusid. # noqa: E501

Update or insert one Configuration Recipe in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Configuration Recipe or failure message if unsuccessful It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_configuration_recipe_with_http_info(upsert_recipe_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_request (UpsertRecipeRequest) – The Configuration Recipe to update or insert (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))

upsert_recipe_composer(upsert_recipe_composer_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid. # noqa: E501

Update or insert one Recipe Composer in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Recipe Composer or failure message if unsuccessful It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_recipe_composer(upsert_recipe_composer_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_composer_request (UpsertRecipeComposerRequest) – The Recipe Composer to update or insert (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UpsertSingleStructuredDataResponse

upsert_recipe_composer_with_http_info(upsert_recipe_composer_request, **kwargs)[source]

[EXPERIMENTAL] UpsertRecipeComposer: Upsert a Recipe Composer. This creates or updates the data in Lusid. # noqa: E501

Update or insert one Recipe Composer in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Recipe Composer or failure message if unsuccessful It is important to always check to verify success (or failure). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_recipe_composer_with_http_info(upsert_recipe_composer_request, async_req=True)
>>> result = thread.get()

Parameters:

upsert_recipe_composer_request (UpsertRecipeComposerRequest) – The Recipe Composer to update or insert (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))