sdk.lusid.api.derived_transaction_portfolios_api.DerivedTransactionPortfoliosApi
- class DerivedTransactionPortfoliosApi(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
CreateDerivedPortfolio: Create derived portfolio # noqa: E501
CreateDerivedPortfolio: Create derived portfolio # noqa: E501
[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
- create_derived_portfolio(scope, create_derived_transaction_portfolio_request=None, async_req=None, **kwargs)[source]
CreateDerivedPortfolio: Create derived portfolio # noqa: E501
Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_derived_portfolio(scope, create_derived_transaction_portfolio_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create the derived transaction portfolio. (required)
create_derived_transaction_portfolio_request (CreateDerivedTransactionPortfolioRequest) – The definition of the derived transaction portfolio.
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:
- create_derived_portfolio_with_http_info(scope, create_derived_transaction_portfolio_request=None, **kwargs)[source]
CreateDerivedPortfolio: Create derived portfolio # noqa: E501
Create a derived transaction portfolio from a parent transaction portfolio (which may itself be derived). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_derived_portfolio_with_http_info(scope, create_derived_transaction_portfolio_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create the derived transaction portfolio. (required)
create_derived_transaction_portfolio_request (CreateDerivedTransactionPortfolioRequest) – The definition of the derived transaction portfolio.
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:
- delete_derived_portfolio_details(scope, code, effective_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
Delete all the portfolio details for a derived transaction portfolio. # 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_derived_portfolio_details(scope, code, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the derived transaction portfolio. (required)
code (str) – The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. (required)
effective_at (str) – The effective date of the change.
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:
- delete_derived_portfolio_details_with_http_info(scope, code, effective_at=None, **kwargs)[source]
[EARLY ACCESS] DeleteDerivedPortfolioDetails: Delete derived portfolio details # noqa: E501
Delete all the portfolio details for a derived transaction portfolio. # 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_derived_portfolio_details_with_http_info(scope, code, effective_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the derived transaction portfolio. (required)
code (str) – The code of the derived transaction portfolio. Together with the scope this uniquely identifies the derived transaction portfolio. (required)
effective_at (str) – The effective date of the change.
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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))