sdk.lusid.api.fund_structures_api.FundStructuresApi
- class FundStructuresApi(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
[EXPERIMENTAL] CreateFundStructure: Create a Fund Structure.
[EXPERIMENTAL] CreateFundStructure: Create a Fund Structure.
[EXPERIMENTAL] GetFundStructure: Get a Fund Structure.
[EXPERIMENTAL] GetFundStructure: Get a Fund Structure.
[EXPERIMENTAL] ListFundStructures: List Fund Structures.
[EXPERIMENTAL] ListFundStructures: List Fund Structures.
- create_fund_structure(scope, fund_structure_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateFundStructure: Create a Fund Structure. # noqa: E501
Create a new Fund Structure Model. The scope and code of the Fund Structure are provided in the request body. # 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_structure(scope, fund_structure_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Fund Structure. (required)
fund_structure_request (FundStructureRequest) – The definition of the Fund Structure. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_fund_structure_with_http_info(scope, fund_structure_request, **kwargs)[source]
[EXPERIMENTAL] CreateFundStructure: Create a Fund Structure. # noqa: E501
Create a new Fund Structure Model. The scope and code of the Fund Structure are provided in the request body. # 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_structure_with_http_info(scope, fund_structure_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Fund Structure. (required)
fund_structure_request (FundStructureRequest) – The definition of the Fund Structure. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(FundStructure, status_code(int), headers(HTTPHeaderDict))
- get_fund_structure(scope, code, as_at=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetFundStructure: Get a Fund Structure. # noqa: E501
Retrieve the definition of a particular Fund Structure, including its nodes, edges, and any inline fund definitions. # 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_structure(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Fund Structure. (required)
code (str) – The code of the Fund Structure. Together with the scope this uniquely identifies the Fund Structure. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Fund Structure. Defaults to returning the latest version if not specified.
property_keys (List[str]) – A list of property keys from the ‘FundStructure’ domain to decorate onto the Fund Structure. These must take the format {domain}/{scope}/{code}, for example ‘FundStructure/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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_fund_structure_with_http_info(scope, code, as_at=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] GetFundStructure: Get a Fund Structure. # noqa: E501
Retrieve the definition of a particular Fund Structure, including its nodes, edges, and any inline fund definitions. # 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_structure_with_http_info(scope, code, as_at, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Fund Structure. (required)
code (str) – The code of the Fund Structure. Together with the scope this uniquely identifies the Fund Structure. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Fund Structure. Defaults to returning the latest version if not specified.
property_keys (List[str]) – A list of property keys from the ‘FundStructure’ domain to decorate onto the Fund Structure. These must take the format {domain}/{scope}/{code}, for example ‘FundStructure/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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(FundStructure, status_code(int), headers(HTTPHeaderDict))
- list_fund_structures(as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListFundStructures: List Fund Structures. # noqa: E501
List all the Fund Structures matching the given 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_fund_structures(as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list Fund Structures. Defaults to returning the latest version of each Fund Structure if not specified.
page (str) – The pagination token to use to continue listing Fund Structures; this value is returned from the previous call. If a pagination token is provided, the filter 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 Structure code, specify “id.Code eq ‘Structure1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – A list of property keys from the ‘FundStructure’ domain to decorate onto each Fund Structure. These must take the format {domain}/{scope}/{code}, for example ‘FundStructure/Manager/Id’.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_fund_structures_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]
[EXPERIMENTAL] ListFundStructures: List Fund Structures. # noqa: E501
List all the Fund Structures matching the given 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_fund_structures_with_http_info(as_at, page, limit, filter, sort_by, property_keys, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list Fund Structures. Defaults to returning the latest version of each Fund Structure if not specified.
page (str) – The pagination token to use to continue listing Fund Structures; this value is returned from the previous call. If a pagination token is provided, the filter 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 Structure code, specify “id.Code eq ‘Structure1’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
property_keys (List[str]) – A list of property keys from the ‘FundStructure’ domain to decorate onto each Fund Structure. These must take the format {domain}/{scope}/{code}, for example ‘FundStructure/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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(PagedResourceListOfFundStructure, status_code(int), headers(HTTPHeaderDict))