sdk.lusid.api.settlement_activity_api.SettlementActivityApi

class SettlementActivityApi(api_client=None)

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

Do not edit the class manually.

Methods

query_settlement_activity	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity # noqa: E501
query_settlement_activity_with_http_info	[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity # noqa: E501

query_settlement_activity(settlement_activity_query, async_req=None, **kwargs)

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity # noqa: E501

Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_settlement_activity(settlement_activity_query, async_req=True)
>>> result = thread.get()

Parameters:

• settlement_activity_query (SettlementActivityQuery) – The query parameters controlling which settlement activity is returned. (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:

ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery

query_settlement_activity_with_http_info(settlement_activity_query, **kwargs)

[EARLY ACCESS] QuerySettlementActivity: Query Settlement Activity # noqa: E501

Queries settlement activity (Expected and Settled) for the specified portfolios and/or portfolio groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_settlement_activity_with_http_info(settlement_activity_query, async_req=True)
>>> result = thread.get()

Parameters:

• settlement_activity_query (SettlementActivityQuery) – The query parameters controlling which settlement activity is returned. (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(ResourceListWithPostBodiesOfSettlementActivityToSettlementActivityQuery, status_code(int), headers(HTTPHeaderDict))