sdk.lusid.api.staged_modifications_api.StagedModificationsApi
- class StagedModificationsApi(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
AddDecision: AddDecision # noqa: E501
AddDecision: AddDecision # noqa: E501
GetStagedModification: GetStagedModification # noqa: E501
GetStagedModification: GetStagedModification # noqa: E501
ListRequestedChanges: ListRequestedChanges # noqa: E501
ListRequestedChanges: ListRequestedChanges # noqa: E501
ListStagedModifications: ListStagedModifications # noqa: E501
ListStagedModifications: ListStagedModifications # noqa: E501
- add_decision(id, staged_modification_decision_request, async_req=None, **kwargs)[source]
AddDecision: AddDecision # noqa: E501
Add decision to staged modification, Approve or Reject. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_decision(id, staged_modification_decision_request, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – Unique Id for a staged modification.. (required)
staged_modification_decision_request (StagedModificationDecisionRequest) – The decision on the requested staged modification, “Approve” or “Reject”. (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:
- add_decision_with_http_info(id, staged_modification_decision_request, **kwargs)[source]
AddDecision: AddDecision # noqa: E501
Add decision to staged modification, Approve or Reject. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_decision_with_http_info(id, staged_modification_decision_request, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – Unique Id for a staged modification.. (required)
staged_modification_decision_request (StagedModificationDecisionRequest) – The decision on the requested staged modification, “Approve” or “Reject”. (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(StagedModification, status_code(int), headers(HTTPHeaderDict))
- get_staged_modification(id, as_at=None, async_req=None, **kwargs)[source]
GetStagedModification: GetStagedModification # noqa: E501
Retrieve the details of a staged modification. # 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_staged_modification(id, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – The unique identifier for a staged modification. (required)
as_at (datetime) – The asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified.
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_staged_modification_with_http_info(id, as_at=None, **kwargs)[source]
GetStagedModification: GetStagedModification # noqa: E501
Retrieve the details of a staged modification. # 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_staged_modification_with_http_info(id, as_at, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – The unique identifier for a staged modification. (required)
as_at (datetime) – The asAt datetime at which to retrieve the staged modification. Defaults to latest 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. 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(StagedModification, status_code(int), headers(HTTPHeaderDict))
- list_requested_changes(id, as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
ListRequestedChanges: ListRequestedChanges # noqa: E501
List the requested changes for a staged modification. # 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_requested_changes(id, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – Unique Id for a staged modification.. (required)
as_at (datetime) – The asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified.
page (str) – The pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. 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 number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names suffixed by “ ASC” or “ DESC”
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:
PagedResourceListOfStagedModificationsRequestedChangeInterval
- list_requested_changes_with_http_info(id, as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
ListRequestedChanges: ListRequestedChanges # noqa: E501
List the requested changes for a staged modification. # 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_requested_changes_with_http_info(id, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
id (str) – Unique Id for a staged modification.. (required)
as_at (datetime) – The asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified.
page (str) – The pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. 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 number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names suffixed by “ ASC” or “ DESC”
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(PagedResourceListOfStagedModificationsRequestedChangeInterval, status_code(int), headers(HTTPHeaderDict))
- list_staged_modifications(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
ListStagedModifications: ListStagedModifications # noqa: E501
List summaries of the staged modifications. # 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_staged_modifications(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified.
page (str) – The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. 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 number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names suffixed by “ ASC” or “ DESC”
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_staged_modifications_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
ListStagedModifications: ListStagedModifications # noqa: E501
List summaries of the staged modifications. # 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_staged_modifications_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified.
page (str) – The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. 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 number of returned results to this many. Defaults to 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names suffixed by “ ASC” or “ DESC”
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(PagedResourceListOfStagedModification, status_code(int), headers(HTTPHeaderDict))