sdk.lusid.api.timelines_api.TimelinesApi

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

`confirm_closed_period`	[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity # noqa: E501
`confirm_closed_period_with_http_info`	[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity # noqa: E501
`create_closed_period`	[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
`create_closed_period_candidate`	[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity # noqa: E501
`create_closed_period_candidate_with_http_info`	[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity # noqa: E501
`create_closed_period_with_http_info`	[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
`create_timeline`	[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501
`create_timeline_with_http_info`	[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501
`delete_timeline`	[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501
`delete_timeline_with_http_info`	[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501
`get_closed_period`	[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity.
`get_closed_period_with_http_info`	[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity.
`get_timeline`	[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.
`get_timeline_with_http_info`	[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.
`list_closed_periods`	[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.
`list_closed_periods_with_http_info`	[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.
`list_timelines`	[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501
`list_timelines_with_http_info`	[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501
`set_post_close_activity`	[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.
`set_post_close_activity_with_http_info`	[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.
`unconfirm_closed_period`	[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501
`unconfirm_closed_period_with_http_info`	[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501
`update_timeline`	[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501
`update_timeline_with_http_info`	[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501

confirm_closed_period(scope, code, closed_period_id, body=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity # noqa: E501

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.confirm_closed_period(scope, code, closed_period_id, body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
body (object) – Not in use at the moment
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:

ClosedPeriod

confirm_closed_period_with_http_info(scope, code, closed_period_id, body=None, **kwargs)[source]

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity # noqa: E501

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.confirm_closed_period_with_http_info(scope, code, closed_period_id, body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
body (object) – Not in use at the moment
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # 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_closed_period(scope, code, create_closed_period_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
create_closed_period_request (CreateClosedPeriodRequest) – The request containing the details of the Closed Period
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:

ClosedPeriod

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

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity # noqa: E501

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties # 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_closed_period_candidate(scope, code, create_closed_period_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
create_closed_period_request (CreateClosedPeriodRequest) – The request containing the details of the Closed Period
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:

ClosedPeriod

create_closed_period_candidate_with_http_info(scope, code, create_closed_period_request=None, **kwargs)[source]

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity # noqa: E501

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties # 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_closed_period_candidate_with_http_info(scope, code, create_closed_period_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
create_closed_period_request (CreateClosedPeriodRequest) – The request containing the details of the Closed Period
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

create_closed_period_with_http_info(scope, code, create_closed_period_request=None, **kwargs)[source]

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # 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_closed_period_with_http_info(scope, code, create_closed_period_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
create_closed_period_request (CreateClosedPeriodRequest) – The request containing the details of the Closed Period
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

create_timeline(create_timeline_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # 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_timeline(create_timeline_request, async_req=True)
>>> result = thread.get()

Parameters:

create_timeline_request (CreateTimelineRequest) – The request containing the details of the Timeline
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:

Timeline

create_timeline_with_http_info(create_timeline_request=None, **kwargs)[source]

[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # 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_timeline_with_http_info(create_timeline_request, async_req=True)
>>> result = thread.get()

Parameters:

create_timeline_request (CreateTimelineRequest) – The request containing the details of the Timeline
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(Timeline, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # 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_timeline(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (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:

DeletedEntityResponse

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

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # 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_timeline_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # 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_closed_period(scope, code, closed_period_id, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
as_at (datetime) – The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘ClosedPeriod’ domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example ‘ClosedPeriod/system/Name’.
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:

ClosedPeriod

get_closed_period_with_http_info(scope, code, closed_period_id, as_at=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # 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_closed_period_with_http_info(scope, code, closed_period_id, as_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
as_at (datetime) – The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘ClosedPeriod’ domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example ‘ClosedPeriod/system/Name’.
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. # noqa: E501

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # 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_timeline(scope, code, as_at, effective_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

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

Timeline

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

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. # noqa: E501

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # 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_timeline_with_http_info(scope, code, as_at, effective_at, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

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

list_closed_periods(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. # noqa: E501

List all the ClosedPeriods matching a 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_closed_periods(scope, code, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. (required)
as_at (datetime) – The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.
page (str) – The pagination token to use to continue listing ClosedPeriods; 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 effectiveEnd, specify “effectiveEnd gt 2019-01-15T10:00:00”. 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 ‘ClosedPeriod’ domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example ‘ClosedPeriod/Account/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:

PagedResourceListOfClosedPeriod

list_closed_periods_with_http_info(scope, code, as_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. # noqa: E501

List all the ClosedPeriods matching a 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_closed_periods_with_http_info(scope, code, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. (required)
as_at (datetime) – The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.
page (str) – The pagination token to use to continue listing ClosedPeriods; 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 effectiveEnd, specify “effectiveEnd gt 2019-01-15T10:00:00”. 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 ‘ClosedPeriod’ domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example ‘ClosedPeriod/Account/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(PagedResourceListOfClosedPeriod, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501

List all the Timelines matching a 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_timelines(as_at, effective_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 the Timelines. Defaults to returning the latest version of each Timeline if not specified.
effective_at (str) – The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
page (str) – The pagination token to use to continue listing Timelines; 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 displayName, specify “displayName eq ‘AccountingTimeline’”. 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 ‘Timeline’ domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example ‘Timeline/Account/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:

PagedResourceListOfTimeline

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

[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501

List all the Timelines matching a 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_timelines_with_http_info(as_at, effective_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 the Timelines. Defaults to returning the latest version of each Timeline if not specified.
effective_at (str) – The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
page (str) – The pagination token to use to continue listing Timelines; 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 displayName, specify “displayName eq ‘AccountingTimeline’”. 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 ‘Timeline’ domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example ‘Timeline/Account/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(PagedResourceListOfTimeline, status_code(int), headers(HTTPHeaderDict))

set_post_close_activity(scope, code, closed_period_id, post_close_activities_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. # noqa: E501

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * PortfolioTransaction, * Instrument, * InstrumentEvent, * InstrumentEventInstruction, * PortfolioSettlementInstruction, and, * Quote. # 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_post_close_activity(scope, code, closed_period_id, post_close_activities_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. (required)
closed_period_id (str) – The ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period. (required)
post_close_activities_request (PostCloseActivitiesRequest) – This specifies a collection of post-close activities.
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:

ClosedPeriod

set_post_close_activity_with_http_info(scope, code, closed_period_id, post_close_activities_request=None, **kwargs)[source]

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. # noqa: E501

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * PortfolioTransaction, * Instrument, * InstrumentEvent, * InstrumentEventInstruction, * PortfolioSettlementInstruction, and, * Quote. # 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_post_close_activity_with_http_info(scope, code, closed_period_id, post_close_activities_request, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the Timeline. (required)
code (str) – The code of the Timeline. (required)
closed_period_id (str) – The ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period. (required)
post_close_activities_request (PostCloseActivitiesRequest) – This specifies a collection of post-close activities.
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

unconfirm_closed_period(scope, code, closed_period_id, body=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501

Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.unconfirm_closed_period(scope, code, closed_period_id, body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline. (required)
body (object) – Not in use at the moment
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:

ClosedPeriod

unconfirm_closed_period_with_http_info(scope, code, closed_period_id, body=None, **kwargs)[source]

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501

Unconfirm the last confirmed Closed Period against a Timeline Entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.unconfirm_closed_period_with_http_info(scope, code, closed_period_id, body, async_req=True)
>>> result = thread.get()

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
closed_period_id (str) – The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline. (required)
body (object) – Not in use at the moment
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))

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

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
update_timeline_request (UpdateTimelineRequest) – The request containing the updated details of the Timeline
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:

Timeline

update_timeline_with_http_info(scope, code, update_timeline_request=None, **kwargs)[source]

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

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

Parameters:

scope (str) – The scope of the specified Timeline. (required)
code (str) – The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
update_timeline_request (UpdateTimelineRequest) – The request containing the updated details of the Timeline
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(Timeline, status_code(int), headers(HTTPHeaderDict))