sdk.lusid.api.funds_api.FundsApi

class FundsApi(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

`accept_estimate_point`	[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point.
`accept_estimate_point_with_http_info`	[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point.
`create_fund`	[EXPERIMENTAL] CreateFund: Create a Fund.
`create_fund_with_http_info`	[EXPERIMENTAL] CreateFund: Create a Fund.
`delete_fund`	[EXPERIMENTAL] DeleteFund: Delete a Fund.
`delete_fund_with_http_info`	[EXPERIMENTAL] DeleteFund: Delete a Fund.
`delete_valuation_point`	[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.
`delete_valuation_point_with_http_info`	[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point.
`finalise_candidate_valuation`	[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate.
`finalise_candidate_valuation_with_http_info`	[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate.
`get_fund`	[EXPERIMENTAL] GetFund: Get a Fund.
`get_fund_with_http_info`	[EXPERIMENTAL] GetFund: Get a Fund.
`get_valuation_point_data`	[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.
`get_valuation_point_data_with_http_info`	[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund.
`list_funds`	[EXPERIMENTAL] ListFunds: List Funds.
`list_funds_with_http_info`	[EXPERIMENTAL] ListFunds: List Funds.
`set_share_class_instruments`	[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
`set_share_class_instruments_with_http_info`	[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund.
`upsert_fund_properties`	[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.
`upsert_fund_properties_with_http_info`	[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties.
`upsert_valuation_point`	[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point.
`upsert_valuation_point_with_http_info`	[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point.

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

[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point. # noqa: E501

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the valuation Point was last run, status will be marked as ‘Candidate’, otherwise it will be marked as ‘Final’ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Final state. (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:

ValuationPointDataResponse

accept_estimate_point_with_http_info(scope, code, valuation_point_data_request, **kwargs)[source]

[EXPERIMENTAL] AcceptEstimatePoint: Accepts an Estimate Valuation Point. # noqa: E501

Accepts the specified estimate Valuation Point. Should the Valuation Point differ since the valuation Point was last run, status will be marked as ‘Candidate’, otherwise it will be marked as ‘Final’ # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the Diary Entry code for the Estimate Valuation Point to move to Final state. (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(ValuationPointDataResponse, status_code(int), headers(HTTPHeaderDict))

create_fund(scope, fund_request, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateFund: Create a Fund. # noqa: E501

Create the given Fund. # 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_fund(scope, fund_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
fund_request (FundRequest) – The definition of the Fund. (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:

Fund

create_fund_with_http_info(scope, fund_request, **kwargs)[source]

[EXPERIMENTAL] CreateFund: Create a Fund. # noqa: E501

Create the given Fund. # 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_fund_with_http_info(scope, fund_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
fund_request (FundRequest) – The definition of the Fund. (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(Fund, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteFund: Delete a Fund. # noqa: E501

Delete the given Fund. # 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_fund(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund to be deleted. (required)
code (str) – The code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund. (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:

DeletedEntityResponse

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

[EXPERIMENTAL] DeleteFund: Delete a Fund. # noqa: E501

Delete the given Fund. # 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_fund_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund to be deleted. (required)
code (str) – The code of the Fund to be deleted. Together with the scope this uniquely identifies the Fund. (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. # noqa: E501

Deletes the given Valuation Point. # 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_valuation_point(scope, code, diary_entry_code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund for the valuation point to be deleted. (required)
code (str) – The code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund. (required)
diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (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:

DeletedEntityResponse

delete_valuation_point_with_http_info(scope, code, diary_entry_code, **kwargs)[source]

[EXPERIMENTAL] DeleteValuationPoint: Delete a Valuation Point. # noqa: E501

Deletes the given Valuation Point. # 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_valuation_point_with_http_info(scope, code, diary_entry_code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund for the valuation point to be deleted. (required)
code (str) – The code of the Fund containing the Valuation Point to be deleted. Together with the scope this uniquely identifies the Fund. (required)
diary_entry_code (str) – The diary entry code for the valuation Point to be deleted. (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate. # noqa: E501

Moves a ‘Candidate’ status Valuation Point to status ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the diary entry code to mark as final. (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:

ValuationPointDataResponse

finalise_candidate_valuation_with_http_info(scope, code, valuation_point_data_request, **kwargs)[source]

[EXPERIMENTAL] FinaliseCandidateValuation: Finalise Candidate. # noqa: E501

Moves a ‘Candidate’ status Valuation Point to status ‘Final’. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_request (ValuationPointDataRequest) – The valuationPointDataRequest which contains the diary entry code to mark as final. (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(ValuationPointDataResponse, status_code(int), headers(HTTPHeaderDict))

get_fund(scope, code, effective_at=None, as_at=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetFund: Get a Fund. # noqa: E501

Retrieve the definition of a particular Fund. # 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_fund(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’. If no properties are specified, then no properties will be returned.
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:

Fund

get_fund_with_http_info(scope, code, effective_at=None, as_at=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] GetFund: Get a Fund. # noqa: E501

Retrieve the definition of a particular Fund. # 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_fund_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Fund properties. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto the Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’. If no properties are specified, then no properties will be returned.
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(Fund, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. # noqa: E501

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the related ABOR’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ DiaryEntry and EndDate will be as provided. # 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_valuation_point_data(scope, code, valuation_point_data_query_parameters, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Valuation Point data (required)
as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition 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:

ValuationPointDataResponse

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

[EXPERIMENTAL] GetValuationPointData: Get Valuation Point Data for a Fund. # noqa: E501

Retrieves the Valuation Point data for a date or specified Diary Entry Id. The endpoint will internally extract all ‘Assets’ and ‘Liabilities’ from the related ABOR’s Trial balance to produce a GAV. Start date will be assumed from the last ‘official’ DiaryEntry and EndDate will be as provided. # 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_valuation_point_data_with_http_info(scope, code, valuation_point_data_query_parameters, as_at, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
valuation_point_data_query_parameters (ValuationPointDataQueryParameters) – The arguments to use for querying the Valuation Point data (required)
as_at (datetime) – The asAt datetime at which to retrieve the Fund definition. Defaults to returning the latest version of the Fund definition 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(ValuationPointDataResponse, status_code(int), headers(HTTPHeaderDict))

list_funds(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListFunds: List Funds. # noqa: E501

List all the Funds matching particular criteria. # 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_funds(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Funds. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified.
page (str) – The pagination token to use to continue listing Funds; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the Fund type, specify “id.Code eq ‘Fund1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”
property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’.
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:

PagedResourceListOfFund

list_funds_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] ListFunds: List Funds. # noqa: E501

List all the Funds matching particular criteria. # 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_funds_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to list the TimeVariant properties for the Funds. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the Funds. Defaults to returning the latest version of each Fund if not specified.
page (str) – The pagination token to use to continue listing Funds; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the Fund type, specify “id.Code eq ‘Fund1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”
property_keys (List[str]) – A list of property keys from the ‘Fund’ domain to decorate onto each Fund. These must take the format {domain}/{scope}/{code}, for example ‘Fund/Manager/Id’.
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(PagedResourceListOfFund, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. # noqa: E501

Update the ShareClass Instruments on an existing fund with the set of instruments provided. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. (required)
set_share_class_instruments_request (SetShareClassInstrumentsRequest) – The scopes and instrument identifiers for the instruments to be set. (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:

Fund

set_share_class_instruments_with_http_info(scope, code, set_share_class_instruments_request, **kwargs)[source]

[EXPERIMENTAL] SetShareClassInstruments: Set the ShareClass Instruments on a fund. # noqa: E501

Update the ShareClass Instruments on an existing fund with the set of instruments provided. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. (required)
set_share_class_instruments_request (SetShareClassInstrumentsRequest) – The scopes and instrument identifiers for the instruments to be set. (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(Fund, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. # noqa: E501

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fund’. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property. # 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_fund_properties(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund to update or insert the properties onto. (required)
code (str) – The code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fund/Manager/Id”.
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:

FundProperties

upsert_fund_properties_with_http_info(scope, code, request_body=None, **kwargs)[source]

[EXPERIMENTAL] UpsertFundProperties: Upsert Fund properties. # noqa: E501

Update or insert one or more properties onto a single Fund. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘Fund’. Upserting a property that exists for an Fund, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property. # 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_fund_properties_with_http_info(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund to update or insert the properties onto. (required)
code (str) – The code of the Fund to update or insert the properties onto. Together with the scope this uniquely identifies the Fund. (required)
request_body (Dict[str, ModelProperty]) – The properties to be updated or inserted onto the Fund. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. “Fund/Manager/Id”.
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(FundProperties, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point. # noqa: E501

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this request. # 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_valuation_point(scope, code, upsert_valuation_point_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to Upsert (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:

DiaryEntry

upsert_valuation_point_with_http_info(scope, code, upsert_valuation_point_request, **kwargs)[source]

[EXPERIMENTAL] UpsertValuationPoint: Upsert Valuation Point. # noqa: E501

Update or insert the estimate Valuation Point. If the Valuation Point does not exist, this method will create it in estimate state. If the Valuation Point already exists and is in estimate state, the Valuation Point will be updated with the newly specified information in this request. # 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_valuation_point_with_http_info(scope, code, upsert_valuation_point_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Fund. (required)
code (str) – The code of the Fund. Together with the scope this uniquely identifies the Fund. (required)
upsert_valuation_point_request (UpsertValuationPointRequest) – The Valuation Point Estimate definition to Upsert (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(DiaryEntry, status_code(int), headers(HTTPHeaderDict))