lusid-sdk 2.1.462__py3-none-any.whl → 2.1.537__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lusid/__init__.py +62 -0
- lusid/api/group_reconciliations_api.py +806 -79
- lusid/api/instruments_api.py +187 -0
- lusid/api/transaction_portfolios_api.py +202 -2
- lusid/configuration.py +1 -1
- lusid/models/__init__.py +62 -0
- lusid/models/accumulation_event.py +3 -3
- lusid/models/amortisation_event.py +3 -3
- lusid/models/applicable_instrument_event.py +7 -2
- lusid/models/asset_leg.py +1 -1
- lusid/models/batch_update_user_review_for_comparison_result_request.py +81 -0
- lusid/models/batch_update_user_review_for_comparison_result_response.py +146 -0
- lusid/models/bond_coupon_event.py +10 -5
- lusid/models/bond_default_event.py +3 -3
- lusid/models/bond_principal_event.py +10 -5
- lusid/models/bonus_issue_event.py +3 -3
- lusid/models/call_on_intermediate_securities_event.py +139 -0
- lusid/models/capital_distribution_event.py +3 -3
- lusid/models/cash_dividend_event.py +3 -3
- lusid/models/cash_flow_event.py +3 -3
- lusid/models/cds_credit_event.py +3 -3
- lusid/models/cdx_credit_event.py +3 -3
- lusid/models/close_event.py +3 -3
- lusid/models/comparison_attribute_value_pair.py +71 -0
- lusid/models/component_transaction.py +10 -3
- lusid/models/create_staging_rule_set_request.py +1 -6
- lusid/models/credit_premium_cash_flow_event.py +3 -3
- lusid/models/custodian_account_request.py +1 -1
- lusid/models/delete_instrument_properties_response.py +7 -1
- lusid/models/delete_instrument_response.py +7 -1
- lusid/models/delete_instruments_response.py +22 -1
- lusid/models/deleted_entity_response.py +7 -1
- lusid/models/dividend_option_event.py +3 -3
- lusid/models/dividend_reinvestment_event.py +9 -4
- lusid/models/equity_option.py +19 -4
- lusid/models/exchange_traded_option_contract_details.py +1 -1
- lusid/models/exercise_event.py +3 -3
- lusid/models/expiry_event.py +3 -3
- lusid/models/fee.py +10 -3
- lusid/models/fee_request.py +13 -6
- lusid/models/future_expiry_event.py +3 -3
- lusid/models/fx_forward_settlement_event.py +3 -3
- lusid/models/group_reconciliation_aggregate_attribute_values.py +86 -0
- lusid/models/group_reconciliation_comparison_result.py +148 -0
- lusid/models/group_reconciliation_core_attribute_values.py +86 -0
- lusid/models/group_reconciliation_date_pair.py +81 -0
- lusid/models/group_reconciliation_dates.py +78 -0
- lusid/models/group_reconciliation_instance_id.py +71 -0
- lusid/models/group_reconciliation_result_statuses.py +89 -0
- lusid/models/group_reconciliation_result_types.py +96 -0
- lusid/models/group_reconciliation_review_statuses.py +96 -0
- lusid/models/group_reconciliation_run_details.py +76 -0
- lusid/models/group_reconciliation_run_request.py +75 -0
- lusid/models/group_reconciliation_run_response.py +77 -0
- lusid/models/group_reconciliation_summary.py +121 -0
- lusid/models/group_reconciliation_user_review.py +112 -0
- lusid/models/group_reconciliation_user_review_add.py +88 -0
- lusid/models/group_reconciliation_user_review_break_code.py +80 -0
- lusid/models/group_reconciliation_user_review_comment.py +80 -0
- lusid/models/group_reconciliation_user_review_match_key.py +80 -0
- lusid/models/group_reconciliation_user_review_remove.py +88 -0
- lusid/models/informational_error_event.py +3 -3
- lusid/models/informational_event.py +3 -3
- lusid/models/instrument_event.py +10 -5
- lusid/models/instrument_event_type.py +5 -0
- lusid/models/intermediate_securities_distribution_event.py +140 -0
- lusid/models/maturity_event.py +3 -3
- lusid/models/mbs_coupon_event.py +10 -5
- lusid/models/mbs_interest_deferral_event.py +10 -5
- lusid/models/mbs_interest_shortfall_event.py +10 -5
- lusid/models/mbs_principal_event.py +10 -5
- lusid/models/mbs_principal_write_off_event.py +10 -5
- lusid/models/merger_event.py +3 -3
- lusid/models/new_instrument.py +1 -1
- lusid/models/open_event.py +3 -3
- lusid/models/option_exercise_cash_event.py +144 -0
- lusid/models/option_exercise_election.py +73 -0
- lusid/models/option_exercise_physical_event.py +149 -0
- lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +113 -0
- lusid/models/pricing_options.py +8 -2
- lusid/models/protection_payout_cash_flow_event.py +102 -0
- lusid/models/raw_vendor_event.py +3 -3
- lusid/models/reset_event.py +3 -3
- lusid/models/resource_list_of_output_transaction.py +113 -0
- lusid/models/return_zero_pv_options.py +69 -0
- lusid/models/reverse_stock_split_event.py +3 -3
- lusid/models/scrip_dividend_event.py +3 -3
- lusid/models/spin_off_event.py +3 -3
- lusid/models/stock_dividend_event.py +3 -3
- lusid/models/stock_split_event.py +3 -3
- lusid/models/swap_cash_flow_event.py +3 -3
- lusid/models/swap_principal_event.py +3 -3
- lusid/models/target_tax_lot.py +23 -2
- lusid/models/target_tax_lot_request.py +23 -2
- lusid/models/tender_event.py +3 -3
- lusid/models/total_return_swap.py +1 -1
- lusid/models/transaction_price.py +3 -3
- lusid/models/transaction_price_type.py +2 -0
- lusid/models/transition_event.py +3 -3
- lusid/models/trigger_event.py +3 -3
- lusid/models/update_staging_rule_set_request.py +1 -6
- {lusid_sdk-2.1.462.dist-info → lusid_sdk-2.1.537.dist-info}/METADATA +40 -3
- {lusid_sdk-2.1.462.dist-info → lusid_sdk-2.1.537.dist-info}/RECORD +104 -73
- {lusid_sdk-2.1.462.dist-info → lusid_sdk-2.1.537.dist-info}/WHEEL +0 -0
@@ -26,11 +26,17 @@ from pydantic.v1 import Field, StrictStr, conint, conlist, constr, validator
|
|
26
26
|
|
27
27
|
from typing import Optional
|
28
28
|
|
29
|
+
from lusid.models.batch_update_user_review_for_comparison_result_request import BatchUpdateUserReviewForComparisonResultRequest
|
30
|
+
from lusid.models.batch_update_user_review_for_comparison_result_response import BatchUpdateUserReviewForComparisonResultResponse
|
29
31
|
from lusid.models.create_group_reconciliation_comparison_ruleset_request import CreateGroupReconciliationComparisonRulesetRequest
|
30
32
|
from lusid.models.create_group_reconciliation_definition_request import CreateGroupReconciliationDefinitionRequest
|
31
33
|
from lusid.models.deleted_entity_response import DeletedEntityResponse
|
34
|
+
from lusid.models.group_reconciliation_comparison_result import GroupReconciliationComparisonResult
|
32
35
|
from lusid.models.group_reconciliation_comparison_ruleset import GroupReconciliationComparisonRuleset
|
33
36
|
from lusid.models.group_reconciliation_definition import GroupReconciliationDefinition
|
37
|
+
from lusid.models.group_reconciliation_run_request import GroupReconciliationRunRequest
|
38
|
+
from lusid.models.group_reconciliation_run_response import GroupReconciliationRunResponse
|
39
|
+
from lusid.models.paged_resource_list_of_group_reconciliation_comparison_result import PagedResourceListOfGroupReconciliationComparisonResult
|
34
40
|
from lusid.models.paged_resource_list_of_group_reconciliation_comparison_ruleset import PagedResourceListOfGroupReconciliationComparisonRuleset
|
35
41
|
from lusid.models.paged_resource_list_of_group_reconciliation_definition import PagedResourceListOfGroupReconciliationDefinition
|
36
42
|
from lusid.models.update_group_reconciliation_comparison_ruleset_request import UpdateGroupReconciliationComparisonRulesetRequest
|
@@ -57,6 +63,188 @@ class GroupReconciliationsApi:
|
|
57
63
|
api_client = ApiClient.get_default()
|
58
64
|
self.api_client = api_client
|
59
65
|
|
66
|
+
@overload
|
67
|
+
async def batch_update_comparison_results(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, **kwargs) -> BatchUpdateUserReviewForComparisonResultResponse: # noqa: E501
|
68
|
+
...
|
69
|
+
|
70
|
+
@overload
|
71
|
+
def batch_update_comparison_results(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpdateUserReviewForComparisonResultResponse: # noqa: E501
|
72
|
+
...
|
73
|
+
|
74
|
+
@validate_arguments
|
75
|
+
def batch_update_comparison_results(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpdateUserReviewForComparisonResultResponse, Awaitable[BatchUpdateUserReviewForComparisonResultResponse]]: # noqa: E501
|
76
|
+
"""[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
|
77
|
+
|
78
|
+
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven't passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501
|
79
|
+
This method makes a synchronous HTTP request by default. To make an
|
80
|
+
asynchronous HTTP request, please pass async_req=True
|
81
|
+
|
82
|
+
>>> thread = api.batch_update_comparison_results(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, async_req=True)
|
83
|
+
>>> result = thread.get()
|
84
|
+
|
85
|
+
:param scope: Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults. (required)
|
86
|
+
:type scope: str
|
87
|
+
:param code: GroupReconciliationDefinitionId code. (required)
|
88
|
+
:type code: str
|
89
|
+
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
|
90
|
+
:type batch_update_user_review_for_comparison_result_request: List[BatchUpdateUserReviewForComparisonResultRequest]
|
91
|
+
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".
|
92
|
+
:type success_mode: str
|
93
|
+
:param async_req: Whether to execute the request asynchronously.
|
94
|
+
:type async_req: bool, optional
|
95
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
96
|
+
:param opts: Configuration options for this request
|
97
|
+
:type opts: ConfigurationOptions, optional
|
98
|
+
:return: Returns the result object.
|
99
|
+
If the method is called asynchronously,
|
100
|
+
returns the request thread.
|
101
|
+
:rtype: BatchUpdateUserReviewForComparisonResultResponse
|
102
|
+
"""
|
103
|
+
kwargs['_return_http_data_only'] = True
|
104
|
+
if '_preload_content' in kwargs:
|
105
|
+
message = "Error! Please call the batch_update_comparison_results_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
106
|
+
raise ValueError(message)
|
107
|
+
if async_req is not None:
|
108
|
+
kwargs['async_req'] = async_req
|
109
|
+
return self.batch_update_comparison_results_with_http_info(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, **kwargs) # noqa: E501
|
110
|
+
|
111
|
+
@validate_arguments
|
112
|
+
def batch_update_comparison_results_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="GroupReconciliationDefinitionId code.")], batch_update_user_review_for_comparison_result_request : Annotated[conlist(BatchUpdateUserReviewForComparisonResultRequest), Field(..., description="A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp.")], success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
113
|
+
"""[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
|
114
|
+
|
115
|
+
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven't passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501
|
116
|
+
This method makes a synchronous HTTP request by default. To make an
|
117
|
+
asynchronous HTTP request, please pass async_req=True
|
118
|
+
|
119
|
+
>>> thread = api.batch_update_comparison_results_with_http_info(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, async_req=True)
|
120
|
+
>>> result = thread.get()
|
121
|
+
|
122
|
+
:param scope: Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults. (required)
|
123
|
+
:type scope: str
|
124
|
+
:param code: GroupReconciliationDefinitionId code. (required)
|
125
|
+
:type code: str
|
126
|
+
:param batch_update_user_review_for_comparison_result_request: A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
|
127
|
+
:type batch_update_user_review_for_comparison_result_request: List[BatchUpdateUserReviewForComparisonResultRequest]
|
128
|
+
:param success_mode: Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. \"Partial\" (default) | \"Atomic\".
|
129
|
+
:type success_mode: str
|
130
|
+
:param async_req: Whether to execute the request asynchronously.
|
131
|
+
:type async_req: bool, optional
|
132
|
+
:param _preload_content: if False, the ApiResponse.data will
|
133
|
+
be set to none and raw_data will store the
|
134
|
+
HTTP response body without reading/decoding.
|
135
|
+
Default is True.
|
136
|
+
:type _preload_content: bool, optional
|
137
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
138
|
+
object with status code, headers, etc
|
139
|
+
:type _return_http_data_only: bool, optional
|
140
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
141
|
+
:param opts: Configuration options for this request
|
142
|
+
:type opts: ConfigurationOptions, optional
|
143
|
+
:param _request_auth: set to override the auth_settings for an a single
|
144
|
+
request; this effectively ignores the authentication
|
145
|
+
in the spec for a single request.
|
146
|
+
:type _request_auth: dict, optional
|
147
|
+
:type _content_type: string, optional: force content-type for the request
|
148
|
+
:return: Returns the result object.
|
149
|
+
If the method is called asynchronously,
|
150
|
+
returns the request thread.
|
151
|
+
:rtype: tuple(BatchUpdateUserReviewForComparisonResultResponse, status_code(int), headers(HTTPHeaderDict))
|
152
|
+
"""
|
153
|
+
|
154
|
+
_params = locals()
|
155
|
+
|
156
|
+
_all_params = [
|
157
|
+
'scope',
|
158
|
+
'code',
|
159
|
+
'batch_update_user_review_for_comparison_result_request',
|
160
|
+
'success_mode'
|
161
|
+
]
|
162
|
+
_all_params.extend(
|
163
|
+
[
|
164
|
+
'async_req',
|
165
|
+
'_return_http_data_only',
|
166
|
+
'_preload_content',
|
167
|
+
'_request_timeout',
|
168
|
+
'_request_auth',
|
169
|
+
'_content_type',
|
170
|
+
'_headers',
|
171
|
+
'opts'
|
172
|
+
]
|
173
|
+
)
|
174
|
+
|
175
|
+
# validate the arguments
|
176
|
+
for _key, _val in _params['kwargs'].items():
|
177
|
+
if _key not in _all_params:
|
178
|
+
raise ApiTypeError(
|
179
|
+
"Got an unexpected keyword argument '%s'"
|
180
|
+
" to method batch_update_comparison_results" % _key
|
181
|
+
)
|
182
|
+
_params[_key] = _val
|
183
|
+
del _params['kwargs']
|
184
|
+
|
185
|
+
_collection_formats = {}
|
186
|
+
|
187
|
+
# process the path parameters
|
188
|
+
_path_params = {}
|
189
|
+
if _params['scope']:
|
190
|
+
_path_params['scope'] = _params['scope']
|
191
|
+
|
192
|
+
if _params['code']:
|
193
|
+
_path_params['code'] = _params['code']
|
194
|
+
|
195
|
+
|
196
|
+
# process the query parameters
|
197
|
+
_query_params = []
|
198
|
+
if _params.get('success_mode') is not None: # noqa: E501
|
199
|
+
_query_params.append(('successMode', _params['success_mode']))
|
200
|
+
|
201
|
+
# process the header parameters
|
202
|
+
_header_params = dict(_params.get('_headers', {}))
|
203
|
+
# process the form parameters
|
204
|
+
_form_params = []
|
205
|
+
_files = {}
|
206
|
+
# process the body parameter
|
207
|
+
_body_params = None
|
208
|
+
if _params['batch_update_user_review_for_comparison_result_request'] is not None:
|
209
|
+
_body_params = _params['batch_update_user_review_for_comparison_result_request']
|
210
|
+
|
211
|
+
# set the HTTP header `Accept`
|
212
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
213
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
214
|
+
|
215
|
+
# set the HTTP header `Content-Type`
|
216
|
+
_content_types_list = _params.get('_content_type',
|
217
|
+
self.api_client.select_header_content_type(
|
218
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
219
|
+
if _content_types_list:
|
220
|
+
_header_params['Content-Type'] = _content_types_list
|
221
|
+
|
222
|
+
# authentication setting
|
223
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
224
|
+
|
225
|
+
_response_types_map = {
|
226
|
+
'200': "BatchUpdateUserReviewForComparisonResultResponse",
|
227
|
+
'400': "LusidValidationProblemDetails",
|
228
|
+
}
|
229
|
+
|
230
|
+
return self.api_client.call_api(
|
231
|
+
'/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/comparisonresults/$batchReview', 'POST',
|
232
|
+
_path_params,
|
233
|
+
_query_params,
|
234
|
+
_header_params,
|
235
|
+
body=_body_params,
|
236
|
+
post_params=_form_params,
|
237
|
+
files=_files,
|
238
|
+
response_types_map=_response_types_map,
|
239
|
+
auth_settings=_auth_settings,
|
240
|
+
async_req=_params.get('async_req'),
|
241
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
242
|
+
_preload_content=_params.get('_preload_content', True),
|
243
|
+
_request_timeout=_params.get('_request_timeout'),
|
244
|
+
opts=_params.get('opts'),
|
245
|
+
collection_formats=_collection_formats,
|
246
|
+
_request_auth=_params.get('_request_auth'))
|
247
|
+
|
60
248
|
@overload
|
61
249
|
async def create_comparison_ruleset(self, create_group_reconciliation_comparison_ruleset_request : Annotated[Optional[CreateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the details of the ruleset")] = None, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
62
250
|
...
|
@@ -692,29 +880,31 @@ class GroupReconciliationsApi:
|
|
692
880
|
_request_auth=_params.get('_request_auth'))
|
693
881
|
|
694
882
|
@overload
|
695
|
-
async def
|
883
|
+
async def get_comparison_result(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GroupReconciliationComparisonResult: # noqa: E501
|
696
884
|
...
|
697
885
|
|
698
886
|
@overload
|
699
|
-
def
|
887
|
+
def get_comparison_result(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonResult: # noqa: E501
|
700
888
|
...
|
701
889
|
|
702
890
|
@validate_arguments
|
703
|
-
def
|
704
|
-
"""[EXPERIMENTAL]
|
891
|
+
def get_comparison_result(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonResult, Awaitable[GroupReconciliationComparisonResult]]: # noqa: E501
|
892
|
+
"""[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
|
705
893
|
|
706
|
-
Retrieves one Group Reconciliation Comparison
|
894
|
+
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
|
707
895
|
This method makes a synchronous HTTP request by default. To make an
|
708
896
|
asynchronous HTTP request, please pass async_req=True
|
709
897
|
|
710
|
-
>>> thread = api.
|
898
|
+
>>> thread = api.get_comparison_result(scope, code, result_id, as_at, async_req=True)
|
711
899
|
>>> result = thread.get()
|
712
900
|
|
713
|
-
:param scope: The scope of the specified comparison
|
901
|
+
:param scope: The scope of the specified comparison result and its related reconciliation definition. (required)
|
714
902
|
:type scope: str
|
715
|
-
:param code: The code of the
|
903
|
+
:param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
|
716
904
|
:type code: str
|
717
|
-
:param
|
905
|
+
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
|
906
|
+
:type result_id: str
|
907
|
+
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.
|
718
908
|
:type as_at: datetime
|
719
909
|
:param async_req: Whether to execute the request asynchronously.
|
720
910
|
:type async_req: bool, optional
|
@@ -724,32 +914,34 @@ class GroupReconciliationsApi:
|
|
724
914
|
:return: Returns the result object.
|
725
915
|
If the method is called asynchronously,
|
726
916
|
returns the request thread.
|
727
|
-
:rtype:
|
917
|
+
:rtype: GroupReconciliationComparisonResult
|
728
918
|
"""
|
729
919
|
kwargs['_return_http_data_only'] = True
|
730
920
|
if '_preload_content' in kwargs:
|
731
|
-
message = "Error! Please call the
|
921
|
+
message = "Error! Please call the get_comparison_result_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
732
922
|
raise ValueError(message)
|
733
923
|
if async_req is not None:
|
734
924
|
kwargs['async_req'] = async_req
|
735
|
-
return self.
|
925
|
+
return self.get_comparison_result_with_http_info(scope, code, result_id, as_at, **kwargs) # noqa: E501
|
736
926
|
|
737
927
|
@validate_arguments
|
738
|
-
def
|
739
|
-
"""[EXPERIMENTAL]
|
928
|
+
def get_comparison_result_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison result and its related reconciliation definition.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the reconciliation definition that was used to produce the reconciliation result.")], result_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
929
|
+
"""[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
|
740
930
|
|
741
|
-
Retrieves one Group Reconciliation Comparison
|
931
|
+
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
|
742
932
|
This method makes a synchronous HTTP request by default. To make an
|
743
933
|
asynchronous HTTP request, please pass async_req=True
|
744
934
|
|
745
|
-
>>> thread = api.
|
935
|
+
>>> thread = api.get_comparison_result_with_http_info(scope, code, result_id, as_at, async_req=True)
|
746
936
|
>>> result = thread.get()
|
747
937
|
|
748
|
-
:param scope: The scope of the specified comparison
|
938
|
+
:param scope: The scope of the specified comparison result and its related reconciliation definition. (required)
|
749
939
|
:type scope: str
|
750
|
-
:param code: The code of the
|
940
|
+
:param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
|
751
941
|
:type code: str
|
752
|
-
:param
|
942
|
+
:param result_id: The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
|
943
|
+
:type result_id: str
|
944
|
+
:param as_at: The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.
|
753
945
|
:type as_at: datetime
|
754
946
|
:param async_req: Whether to execute the request asynchronously.
|
755
947
|
:type async_req: bool, optional
|
@@ -772,7 +964,7 @@ class GroupReconciliationsApi:
|
|
772
964
|
:return: Returns the result object.
|
773
965
|
If the method is called asynchronously,
|
774
966
|
returns the request thread.
|
775
|
-
:rtype: tuple(
|
967
|
+
:rtype: tuple(GroupReconciliationComparisonResult, status_code(int), headers(HTTPHeaderDict))
|
776
968
|
"""
|
777
969
|
|
778
970
|
_params = locals()
|
@@ -780,6 +972,7 @@ class GroupReconciliationsApi:
|
|
780
972
|
_all_params = [
|
781
973
|
'scope',
|
782
974
|
'code',
|
975
|
+
'result_id',
|
783
976
|
'as_at'
|
784
977
|
]
|
785
978
|
_all_params.extend(
|
@@ -800,7 +993,7 @@ class GroupReconciliationsApi:
|
|
800
993
|
if _key not in _all_params:
|
801
994
|
raise ApiTypeError(
|
802
995
|
"Got an unexpected keyword argument '%s'"
|
803
|
-
" to method
|
996
|
+
" to method get_comparison_result" % _key
|
804
997
|
)
|
805
998
|
_params[_key] = _val
|
806
999
|
del _params['kwargs']
|
@@ -815,6 +1008,9 @@ class GroupReconciliationsApi:
|
|
815
1008
|
if _params['code']:
|
816
1009
|
_path_params['code'] = _params['code']
|
817
1010
|
|
1011
|
+
if _params['result_id']:
|
1012
|
+
_path_params['resultId'] = _params['result_id']
|
1013
|
+
|
818
1014
|
|
819
1015
|
# process the query parameters
|
820
1016
|
_query_params = []
|
@@ -839,12 +1035,12 @@ class GroupReconciliationsApi:
|
|
839
1035
|
_auth_settings = ['oauth2'] # noqa: E501
|
840
1036
|
|
841
1037
|
_response_types_map = {
|
842
|
-
'200': "
|
1038
|
+
'200': "GroupReconciliationComparisonResult",
|
843
1039
|
'400': "LusidValidationProblemDetails",
|
844
1040
|
}
|
845
1041
|
|
846
1042
|
return self.api_client.call_api(
|
847
|
-
'/api/reconciliations/
|
1043
|
+
'/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/{resultId}', 'GET',
|
848
1044
|
_path_params,
|
849
1045
|
_query_params,
|
850
1046
|
_header_params,
|
@@ -862,31 +1058,29 @@ class GroupReconciliationsApi:
|
|
862
1058
|
_request_auth=_params.get('_request_auth'))
|
863
1059
|
|
864
1060
|
@overload
|
865
|
-
async def
|
1061
|
+
async def get_comparison_ruleset(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
866
1062
|
...
|
867
1063
|
|
868
1064
|
@overload
|
869
|
-
def
|
1065
|
+
def get_comparison_ruleset(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
870
1066
|
...
|
871
1067
|
|
872
1068
|
@validate_arguments
|
873
|
-
def
|
874
|
-
"""[EXPERIMENTAL]
|
1069
|
+
def get_comparison_ruleset(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonRuleset, Awaitable[GroupReconciliationComparisonRuleset]]: # noqa: E501
|
1070
|
+
"""[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
875
1071
|
|
876
|
-
Retrieves
|
1072
|
+
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
877
1073
|
This method makes a synchronous HTTP request by default. To make an
|
878
1074
|
asynchronous HTTP request, please pass async_req=True
|
879
1075
|
|
880
|
-
>>> thread = api.
|
1076
|
+
>>> thread = api.get_comparison_ruleset(scope, code, as_at, async_req=True)
|
881
1077
|
>>> result = thread.get()
|
882
1078
|
|
883
|
-
:param scope: The scope of the
|
1079
|
+
:param scope: The scope of the specified comparison ruleset. (required)
|
884
1080
|
:type scope: str
|
885
|
-
:param code: The code of the
|
1081
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
886
1082
|
:type code: str
|
887
|
-
:param
|
888
|
-
:type effective_at: str
|
889
|
-
:param as_at: The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
1083
|
+
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.
|
890
1084
|
:type as_at: datetime
|
891
1085
|
:param async_req: Whether to execute the request asynchronously.
|
892
1086
|
:type async_req: bool, optional
|
@@ -896,34 +1090,32 @@ class GroupReconciliationsApi:
|
|
896
1090
|
:return: Returns the result object.
|
897
1091
|
If the method is called asynchronously,
|
898
1092
|
returns the request thread.
|
899
|
-
:rtype:
|
1093
|
+
:rtype: GroupReconciliationComparisonRuleset
|
900
1094
|
"""
|
901
1095
|
kwargs['_return_http_data_only'] = True
|
902
1096
|
if '_preload_content' in kwargs:
|
903
|
-
message = "Error! Please call the
|
1097
|
+
message = "Error! Please call the get_comparison_ruleset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
904
1098
|
raise ValueError(message)
|
905
1099
|
if async_req is not None:
|
906
1100
|
kwargs['async_req'] = async_req
|
907
|
-
return self.
|
1101
|
+
return self.get_comparison_ruleset_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
908
1102
|
|
909
1103
|
@validate_arguments
|
910
|
-
def
|
911
|
-
"""[EXPERIMENTAL]
|
1104
|
+
def get_comparison_ruleset_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1105
|
+
"""[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
912
1106
|
|
913
|
-
Retrieves
|
1107
|
+
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
|
914
1108
|
This method makes a synchronous HTTP request by default. To make an
|
915
1109
|
asynchronous HTTP request, please pass async_req=True
|
916
1110
|
|
917
|
-
>>> thread = api.
|
1111
|
+
>>> thread = api.get_comparison_ruleset_with_http_info(scope, code, as_at, async_req=True)
|
918
1112
|
>>> result = thread.get()
|
919
1113
|
|
920
|
-
:param scope: The scope of the
|
1114
|
+
:param scope: The scope of the specified comparison ruleset. (required)
|
921
1115
|
:type scope: str
|
922
|
-
:param code: The code of the
|
1116
|
+
:param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
|
923
1117
|
:type code: str
|
924
|
-
:param
|
925
|
-
:type effective_at: str
|
926
|
-
:param as_at: The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
1118
|
+
:param as_at: The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.
|
927
1119
|
:type as_at: datetime
|
928
1120
|
:param async_req: Whether to execute the request asynchronously.
|
929
1121
|
:type async_req: bool, optional
|
@@ -946,7 +1138,7 @@ class GroupReconciliationsApi:
|
|
946
1138
|
:return: Returns the result object.
|
947
1139
|
If the method is called asynchronously,
|
948
1140
|
returns the request thread.
|
949
|
-
:rtype: tuple(
|
1141
|
+
:rtype: tuple(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
|
950
1142
|
"""
|
951
1143
|
|
952
1144
|
_params = locals()
|
@@ -954,7 +1146,6 @@ class GroupReconciliationsApi:
|
|
954
1146
|
_all_params = [
|
955
1147
|
'scope',
|
956
1148
|
'code',
|
957
|
-
'effective_at',
|
958
1149
|
'as_at'
|
959
1150
|
]
|
960
1151
|
_all_params.extend(
|
@@ -975,7 +1166,7 @@ class GroupReconciliationsApi:
|
|
975
1166
|
if _key not in _all_params:
|
976
1167
|
raise ApiTypeError(
|
977
1168
|
"Got an unexpected keyword argument '%s'"
|
978
|
-
" to method
|
1169
|
+
" to method get_comparison_ruleset" % _key
|
979
1170
|
)
|
980
1171
|
_params[_key] = _val
|
981
1172
|
del _params['kwargs']
|
@@ -993,9 +1184,6 @@ class GroupReconciliationsApi:
|
|
993
1184
|
|
994
1185
|
# process the query parameters
|
995
1186
|
_query_params = []
|
996
|
-
if _params.get('effective_at') is not None: # noqa: E501
|
997
|
-
_query_params.append(('effectiveAt', _params['effective_at']))
|
998
|
-
|
999
1187
|
if _params.get('as_at') is not None: # noqa: E501
|
1000
1188
|
if isinstance(_params['as_at'], datetime):
|
1001
1189
|
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
@@ -1017,12 +1205,12 @@ class GroupReconciliationsApi:
|
|
1017
1205
|
_auth_settings = ['oauth2'] # noqa: E501
|
1018
1206
|
|
1019
1207
|
_response_types_map = {
|
1020
|
-
'200': "
|
1208
|
+
'200': "GroupReconciliationComparisonRuleset",
|
1021
1209
|
'400': "LusidValidationProblemDetails",
|
1022
1210
|
}
|
1023
1211
|
|
1024
1212
|
return self.api_client.call_api(
|
1025
|
-
'/api/reconciliations/
|
1213
|
+
'/api/reconciliations/comparisonrulesets/{scope}/{code}', 'GET',
|
1026
1214
|
_path_params,
|
1027
1215
|
_query_params,
|
1028
1216
|
_header_params,
|
@@ -1040,34 +1228,32 @@ class GroupReconciliationsApi:
|
|
1040
1228
|
_request_auth=_params.get('_request_auth'))
|
1041
1229
|
|
1042
1230
|
@overload
|
1043
|
-
async def
|
1231
|
+
async def get_group_reconciliation_definition(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
|
1044
1232
|
...
|
1045
1233
|
|
1046
1234
|
@overload
|
1047
|
-
def
|
1235
|
+
def get_group_reconciliation_definition(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
|
1048
1236
|
...
|
1049
1237
|
|
1050
1238
|
@validate_arguments
|
1051
|
-
def
|
1052
|
-
"""[EXPERIMENTAL]
|
1239
|
+
def get_group_reconciliation_definition(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationDefinition, Awaitable[GroupReconciliationDefinition]]: # noqa: E501
|
1240
|
+
"""[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
|
1053
1241
|
|
1054
|
-
Retrieves
|
1242
|
+
Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
|
1055
1243
|
This method makes a synchronous HTTP request by default. To make an
|
1056
1244
|
asynchronous HTTP request, please pass async_req=True
|
1057
1245
|
|
1058
|
-
>>> thread = api.
|
1246
|
+
>>> thread = api.get_group_reconciliation_definition(scope, code, effective_at, as_at, async_req=True)
|
1059
1247
|
>>> result = thread.get()
|
1060
1248
|
|
1061
|
-
:param
|
1249
|
+
:param scope: The scope of the group reconciliation definition to retrieve. (required)
|
1250
|
+
:type scope: str
|
1251
|
+
:param code: The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
|
1252
|
+
:type code: str
|
1253
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
|
1254
|
+
:type effective_at: str
|
1255
|
+
:param as_at: The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
1062
1256
|
:type as_at: datetime
|
1063
|
-
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1064
|
-
:type page: str
|
1065
|
-
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1066
|
-
:type sort_by: List[str]
|
1067
|
-
:param limit: When paginating, limit the number of returned results to this many per page.
|
1068
|
-
:type limit: int
|
1069
|
-
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1070
|
-
:type filter: str
|
1071
1257
|
:param async_req: Whether to execute the request asynchronously.
|
1072
1258
|
:type async_req: bool, optional
|
1073
1259
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -1076,30 +1262,397 @@ class GroupReconciliationsApi:
|
|
1076
1262
|
:return: Returns the result object.
|
1077
1263
|
If the method is called asynchronously,
|
1078
1264
|
returns the request thread.
|
1079
|
-
:rtype:
|
1265
|
+
:rtype: GroupReconciliationDefinition
|
1080
1266
|
"""
|
1081
1267
|
kwargs['_return_http_data_only'] = True
|
1082
1268
|
if '_preload_content' in kwargs:
|
1083
|
-
message = "Error! Please call the
|
1269
|
+
message = "Error! Please call the get_group_reconciliation_definition_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1084
1270
|
raise ValueError(message)
|
1085
1271
|
if async_req is not None:
|
1086
1272
|
kwargs['async_req'] = async_req
|
1087
|
-
return self.
|
1273
|
+
return self.get_group_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
|
1088
1274
|
|
1089
1275
|
@validate_arguments
|
1090
|
-
def
|
1091
|
-
"""[EXPERIMENTAL]
|
1276
|
+
def get_group_reconciliation_definition_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to retrieve.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1277
|
+
"""[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
|
1092
1278
|
|
1093
|
-
Retrieves
|
1279
|
+
Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
|
1094
1280
|
This method makes a synchronous HTTP request by default. To make an
|
1095
1281
|
asynchronous HTTP request, please pass async_req=True
|
1096
1282
|
|
1097
|
-
>>> thread = api.
|
1283
|
+
>>> thread = api.get_group_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, async_req=True)
|
1098
1284
|
>>> result = thread.get()
|
1099
1285
|
|
1100
|
-
:param
|
1101
|
-
:type
|
1102
|
-
:param
|
1286
|
+
:param scope: The scope of the group reconciliation definition to retrieve. (required)
|
1287
|
+
:type scope: str
|
1288
|
+
:param code: The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
|
1289
|
+
:type code: str
|
1290
|
+
:param effective_at: The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
|
1291
|
+
:type effective_at: str
|
1292
|
+
:param as_at: The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.
|
1293
|
+
:type as_at: datetime
|
1294
|
+
:param async_req: Whether to execute the request asynchronously.
|
1295
|
+
:type async_req: bool, optional
|
1296
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1297
|
+
be set to none and raw_data will store the
|
1298
|
+
HTTP response body without reading/decoding.
|
1299
|
+
Default is True.
|
1300
|
+
:type _preload_content: bool, optional
|
1301
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1302
|
+
object with status code, headers, etc
|
1303
|
+
:type _return_http_data_only: bool, optional
|
1304
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1305
|
+
:param opts: Configuration options for this request
|
1306
|
+
:type opts: ConfigurationOptions, optional
|
1307
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1308
|
+
request; this effectively ignores the authentication
|
1309
|
+
in the spec for a single request.
|
1310
|
+
:type _request_auth: dict, optional
|
1311
|
+
:type _content_type: string, optional: force content-type for the request
|
1312
|
+
:return: Returns the result object.
|
1313
|
+
If the method is called asynchronously,
|
1314
|
+
returns the request thread.
|
1315
|
+
:rtype: tuple(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
|
1316
|
+
"""
|
1317
|
+
|
1318
|
+
_params = locals()
|
1319
|
+
|
1320
|
+
_all_params = [
|
1321
|
+
'scope',
|
1322
|
+
'code',
|
1323
|
+
'effective_at',
|
1324
|
+
'as_at'
|
1325
|
+
]
|
1326
|
+
_all_params.extend(
|
1327
|
+
[
|
1328
|
+
'async_req',
|
1329
|
+
'_return_http_data_only',
|
1330
|
+
'_preload_content',
|
1331
|
+
'_request_timeout',
|
1332
|
+
'_request_auth',
|
1333
|
+
'_content_type',
|
1334
|
+
'_headers',
|
1335
|
+
'opts'
|
1336
|
+
]
|
1337
|
+
)
|
1338
|
+
|
1339
|
+
# validate the arguments
|
1340
|
+
for _key, _val in _params['kwargs'].items():
|
1341
|
+
if _key not in _all_params:
|
1342
|
+
raise ApiTypeError(
|
1343
|
+
"Got an unexpected keyword argument '%s'"
|
1344
|
+
" to method get_group_reconciliation_definition" % _key
|
1345
|
+
)
|
1346
|
+
_params[_key] = _val
|
1347
|
+
del _params['kwargs']
|
1348
|
+
|
1349
|
+
_collection_formats = {}
|
1350
|
+
|
1351
|
+
# process the path parameters
|
1352
|
+
_path_params = {}
|
1353
|
+
if _params['scope']:
|
1354
|
+
_path_params['scope'] = _params['scope']
|
1355
|
+
|
1356
|
+
if _params['code']:
|
1357
|
+
_path_params['code'] = _params['code']
|
1358
|
+
|
1359
|
+
|
1360
|
+
# process the query parameters
|
1361
|
+
_query_params = []
|
1362
|
+
if _params.get('effective_at') is not None: # noqa: E501
|
1363
|
+
_query_params.append(('effectiveAt', _params['effective_at']))
|
1364
|
+
|
1365
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1366
|
+
if isinstance(_params['as_at'], datetime):
|
1367
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1368
|
+
else:
|
1369
|
+
_query_params.append(('asAt', _params['as_at']))
|
1370
|
+
|
1371
|
+
# process the header parameters
|
1372
|
+
_header_params = dict(_params.get('_headers', {}))
|
1373
|
+
# process the form parameters
|
1374
|
+
_form_params = []
|
1375
|
+
_files = {}
|
1376
|
+
# process the body parameter
|
1377
|
+
_body_params = None
|
1378
|
+
# set the HTTP header `Accept`
|
1379
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1380
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1381
|
+
|
1382
|
+
# authentication setting
|
1383
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1384
|
+
|
1385
|
+
_response_types_map = {
|
1386
|
+
'200': "GroupReconciliationDefinition",
|
1387
|
+
'400': "LusidValidationProblemDetails",
|
1388
|
+
}
|
1389
|
+
|
1390
|
+
return self.api_client.call_api(
|
1391
|
+
'/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}', 'GET',
|
1392
|
+
_path_params,
|
1393
|
+
_query_params,
|
1394
|
+
_header_params,
|
1395
|
+
body=_body_params,
|
1396
|
+
post_params=_form_params,
|
1397
|
+
files=_files,
|
1398
|
+
response_types_map=_response_types_map,
|
1399
|
+
auth_settings=_auth_settings,
|
1400
|
+
async_req=_params.get('async_req'),
|
1401
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1402
|
+
_preload_content=_params.get('_preload_content', True),
|
1403
|
+
_request_timeout=_params.get('_request_timeout'),
|
1404
|
+
opts=_params.get('opts'),
|
1405
|
+
collection_formats=_collection_formats,
|
1406
|
+
_request_auth=_params.get('_request_auth'))
|
1407
|
+
|
1408
|
+
@overload
|
1409
|
+
async def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfGroupReconciliationComparisonResult: # noqa: E501
|
1410
|
+
...
|
1411
|
+
|
1412
|
+
@overload
|
1413
|
+
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfGroupReconciliationComparisonResult: # noqa: E501
|
1414
|
+
...
|
1415
|
+
|
1416
|
+
@validate_arguments
|
1417
|
+
def list_comparison_results(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfGroupReconciliationComparisonResult, Awaitable[PagedResourceListOfGroupReconciliationComparisonResult]]: # noqa: E501
|
1418
|
+
"""[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
|
1419
|
+
|
1420
|
+
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # noqa: E501
|
1421
|
+
This method makes a synchronous HTTP request by default. To make an
|
1422
|
+
asynchronous HTTP request, please pass async_req=True
|
1423
|
+
|
1424
|
+
>>> thread = api.list_comparison_results(as_at, page, sort_by, limit, filter, async_req=True)
|
1425
|
+
>>> result = thread.get()
|
1426
|
+
|
1427
|
+
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
|
1428
|
+
:type as_at: datetime
|
1429
|
+
:param page: The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1430
|
+
:type page: str
|
1431
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1432
|
+
:type sort_by: List[str]
|
1433
|
+
:param limit: When paginating, limit the number of returned results to this many per page.
|
1434
|
+
:type limit: int
|
1435
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1436
|
+
:type filter: str
|
1437
|
+
:param async_req: Whether to execute the request asynchronously.
|
1438
|
+
:type async_req: bool, optional
|
1439
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1440
|
+
:param opts: Configuration options for this request
|
1441
|
+
:type opts: ConfigurationOptions, optional
|
1442
|
+
:return: Returns the result object.
|
1443
|
+
If the method is called asynchronously,
|
1444
|
+
returns the request thread.
|
1445
|
+
:rtype: PagedResourceListOfGroupReconciliationComparisonResult
|
1446
|
+
"""
|
1447
|
+
kwargs['_return_http_data_only'] = True
|
1448
|
+
if '_preload_content' in kwargs:
|
1449
|
+
message = "Error! Please call the list_comparison_results_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1450
|
+
raise ValueError(message)
|
1451
|
+
if async_req is not None:
|
1452
|
+
kwargs['async_req'] = async_req
|
1453
|
+
return self.list_comparison_results_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1454
|
+
|
1455
|
+
@validate_arguments
|
1456
|
+
def list_comparison_results_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1457
|
+
"""[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
|
1458
|
+
|
1459
|
+
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # noqa: E501
|
1460
|
+
This method makes a synchronous HTTP request by default. To make an
|
1461
|
+
asynchronous HTTP request, please pass async_req=True
|
1462
|
+
|
1463
|
+
>>> thread = api.list_comparison_results_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
1464
|
+
>>> result = thread.get()
|
1465
|
+
|
1466
|
+
:param as_at: The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
|
1467
|
+
:type as_at: datetime
|
1468
|
+
:param page: The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1469
|
+
:type page: str
|
1470
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".
|
1471
|
+
:type sort_by: List[str]
|
1472
|
+
:param limit: When paginating, limit the number of returned results to this many per page.
|
1473
|
+
:type limit: int
|
1474
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1475
|
+
:type filter: str
|
1476
|
+
:param async_req: Whether to execute the request asynchronously.
|
1477
|
+
:type async_req: bool, optional
|
1478
|
+
:param _preload_content: if False, the ApiResponse.data will
|
1479
|
+
be set to none and raw_data will store the
|
1480
|
+
HTTP response body without reading/decoding.
|
1481
|
+
Default is True.
|
1482
|
+
:type _preload_content: bool, optional
|
1483
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
1484
|
+
object with status code, headers, etc
|
1485
|
+
:type _return_http_data_only: bool, optional
|
1486
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1487
|
+
:param opts: Configuration options for this request
|
1488
|
+
:type opts: ConfigurationOptions, optional
|
1489
|
+
:param _request_auth: set to override the auth_settings for an a single
|
1490
|
+
request; this effectively ignores the authentication
|
1491
|
+
in the spec for a single request.
|
1492
|
+
:type _request_auth: dict, optional
|
1493
|
+
:type _content_type: string, optional: force content-type for the request
|
1494
|
+
:return: Returns the result object.
|
1495
|
+
If the method is called asynchronously,
|
1496
|
+
returns the request thread.
|
1497
|
+
:rtype: tuple(PagedResourceListOfGroupReconciliationComparisonResult, status_code(int), headers(HTTPHeaderDict))
|
1498
|
+
"""
|
1499
|
+
|
1500
|
+
_params = locals()
|
1501
|
+
|
1502
|
+
_all_params = [
|
1503
|
+
'as_at',
|
1504
|
+
'page',
|
1505
|
+
'sort_by',
|
1506
|
+
'limit',
|
1507
|
+
'filter'
|
1508
|
+
]
|
1509
|
+
_all_params.extend(
|
1510
|
+
[
|
1511
|
+
'async_req',
|
1512
|
+
'_return_http_data_only',
|
1513
|
+
'_preload_content',
|
1514
|
+
'_request_timeout',
|
1515
|
+
'_request_auth',
|
1516
|
+
'_content_type',
|
1517
|
+
'_headers',
|
1518
|
+
'opts'
|
1519
|
+
]
|
1520
|
+
)
|
1521
|
+
|
1522
|
+
# validate the arguments
|
1523
|
+
for _key, _val in _params['kwargs'].items():
|
1524
|
+
if _key not in _all_params:
|
1525
|
+
raise ApiTypeError(
|
1526
|
+
"Got an unexpected keyword argument '%s'"
|
1527
|
+
" to method list_comparison_results" % _key
|
1528
|
+
)
|
1529
|
+
_params[_key] = _val
|
1530
|
+
del _params['kwargs']
|
1531
|
+
|
1532
|
+
_collection_formats = {}
|
1533
|
+
|
1534
|
+
# process the path parameters
|
1535
|
+
_path_params = {}
|
1536
|
+
|
1537
|
+
# process the query parameters
|
1538
|
+
_query_params = []
|
1539
|
+
if _params.get('as_at') is not None: # noqa: E501
|
1540
|
+
if isinstance(_params['as_at'], datetime):
|
1541
|
+
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
|
1542
|
+
else:
|
1543
|
+
_query_params.append(('asAt', _params['as_at']))
|
1544
|
+
|
1545
|
+
if _params.get('page') is not None: # noqa: E501
|
1546
|
+
_query_params.append(('page', _params['page']))
|
1547
|
+
|
1548
|
+
if _params.get('sort_by') is not None: # noqa: E501
|
1549
|
+
_query_params.append(('sortBy', _params['sort_by']))
|
1550
|
+
_collection_formats['sortBy'] = 'multi'
|
1551
|
+
|
1552
|
+
if _params.get('limit') is not None: # noqa: E501
|
1553
|
+
_query_params.append(('limit', _params['limit']))
|
1554
|
+
|
1555
|
+
if _params.get('filter') is not None: # noqa: E501
|
1556
|
+
_query_params.append(('filter', _params['filter']))
|
1557
|
+
|
1558
|
+
# process the header parameters
|
1559
|
+
_header_params = dict(_params.get('_headers', {}))
|
1560
|
+
# process the form parameters
|
1561
|
+
_form_params = []
|
1562
|
+
_files = {}
|
1563
|
+
# process the body parameter
|
1564
|
+
_body_params = None
|
1565
|
+
# set the HTTP header `Accept`
|
1566
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
1567
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
1568
|
+
|
1569
|
+
# authentication setting
|
1570
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
1571
|
+
|
1572
|
+
_response_types_map = {
|
1573
|
+
'200': "PagedResourceListOfGroupReconciliationComparisonResult",
|
1574
|
+
'400': "LusidValidationProblemDetails",
|
1575
|
+
}
|
1576
|
+
|
1577
|
+
return self.api_client.call_api(
|
1578
|
+
'/api/reconciliations/comparisonresults', 'GET',
|
1579
|
+
_path_params,
|
1580
|
+
_query_params,
|
1581
|
+
_header_params,
|
1582
|
+
body=_body_params,
|
1583
|
+
post_params=_form_params,
|
1584
|
+
files=_files,
|
1585
|
+
response_types_map=_response_types_map,
|
1586
|
+
auth_settings=_auth_settings,
|
1587
|
+
async_req=_params.get('async_req'),
|
1588
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
1589
|
+
_preload_content=_params.get('_preload_content', True),
|
1590
|
+
_request_timeout=_params.get('_request_timeout'),
|
1591
|
+
opts=_params.get('opts'),
|
1592
|
+
collection_formats=_collection_formats,
|
1593
|
+
_request_auth=_params.get('_request_auth'))
|
1594
|
+
|
1595
|
+
@overload
|
1596
|
+
async def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> PagedResourceListOfGroupReconciliationComparisonRuleset: # noqa: E501
|
1597
|
+
...
|
1598
|
+
|
1599
|
+
@overload
|
1600
|
+
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfGroupReconciliationComparisonRuleset: # noqa: E501
|
1601
|
+
...
|
1602
|
+
|
1603
|
+
@validate_arguments
|
1604
|
+
def list_comparison_rulesets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfGroupReconciliationComparisonRuleset, Awaitable[PagedResourceListOfGroupReconciliationComparisonRuleset]]: # noqa: E501
|
1605
|
+
"""[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
|
1606
|
+
|
1607
|
+
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
1608
|
+
This method makes a synchronous HTTP request by default. To make an
|
1609
|
+
asynchronous HTTP request, please pass async_req=True
|
1610
|
+
|
1611
|
+
>>> thread = api.list_comparison_rulesets(as_at, page, sort_by, limit, filter, async_req=True)
|
1612
|
+
>>> result = thread.get()
|
1613
|
+
|
1614
|
+
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
|
1615
|
+
:type as_at: datetime
|
1616
|
+
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1617
|
+
:type page: str
|
1618
|
+
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1619
|
+
:type sort_by: List[str]
|
1620
|
+
:param limit: When paginating, limit the number of returned results to this many per page.
|
1621
|
+
:type limit: int
|
1622
|
+
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
1623
|
+
:type filter: str
|
1624
|
+
:param async_req: Whether to execute the request asynchronously.
|
1625
|
+
:type async_req: bool, optional
|
1626
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
1627
|
+
:param opts: Configuration options for this request
|
1628
|
+
:type opts: ConfigurationOptions, optional
|
1629
|
+
:return: Returns the result object.
|
1630
|
+
If the method is called asynchronously,
|
1631
|
+
returns the request thread.
|
1632
|
+
:rtype: PagedResourceListOfGroupReconciliationComparisonRuleset
|
1633
|
+
"""
|
1634
|
+
kwargs['_return_http_data_only'] = True
|
1635
|
+
if '_preload_content' in kwargs:
|
1636
|
+
message = "Error! Please call the list_comparison_rulesets_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
1637
|
+
raise ValueError(message)
|
1638
|
+
if async_req is not None:
|
1639
|
+
kwargs['async_req'] = async_req
|
1640
|
+
return self.list_comparison_rulesets_with_http_info(as_at, page, sort_by, limit, filter, **kwargs) # noqa: E501
|
1641
|
+
|
1642
|
+
@validate_arguments
|
1643
|
+
def list_comparison_rulesets_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many per page.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1644
|
+
"""[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
|
1645
|
+
|
1646
|
+
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # noqa: E501
|
1647
|
+
This method makes a synchronous HTTP request by default. To make an
|
1648
|
+
asynchronous HTTP request, please pass async_req=True
|
1649
|
+
|
1650
|
+
>>> thread = api.list_comparison_rulesets_with_http_info(as_at, page, sort_by, limit, filter, async_req=True)
|
1651
|
+
>>> result = thread.get()
|
1652
|
+
|
1653
|
+
:param as_at: The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
|
1654
|
+
:type as_at: datetime
|
1655
|
+
:param page: The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
|
1103
1656
|
:type page: str
|
1104
1657
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
1105
1658
|
:type sort_by: List[str]
|
@@ -1421,6 +1974,180 @@ class GroupReconciliationsApi:
|
|
1421
1974
|
collection_formats=_collection_formats,
|
1422
1975
|
_request_auth=_params.get('_request_auth'))
|
1423
1976
|
|
1977
|
+
@overload
|
1978
|
+
async def run_reconciliation(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, **kwargs) -> GroupReconciliationRunResponse: # noqa: E501
|
1979
|
+
...
|
1980
|
+
|
1981
|
+
@overload
|
1982
|
+
def run_reconciliation(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationRunResponse: # noqa: E501
|
1983
|
+
...
|
1984
|
+
|
1985
|
+
@validate_arguments
|
1986
|
+
def run_reconciliation(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationRunResponse, Awaitable[GroupReconciliationRunResponse]]: # noqa: E501
|
1987
|
+
"""[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
|
1988
|
+
|
1989
|
+
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code Supports pagination. # noqa: E501
|
1990
|
+
This method makes a synchronous HTTP request by default. To make an
|
1991
|
+
asynchronous HTTP request, please pass async_req=True
|
1992
|
+
|
1993
|
+
>>> thread = api.run_reconciliation(scope, code, group_reconciliation_run_request, async_req=True)
|
1994
|
+
>>> result = thread.get()
|
1995
|
+
|
1996
|
+
:param scope: The scope of the group reconciliation definition to use for the reconciliation. (required)
|
1997
|
+
:type scope: str
|
1998
|
+
:param code: The code of the group reconciliation definition to use for the reconciliation. (required)
|
1999
|
+
:type code: str
|
2000
|
+
:param group_reconciliation_run_request:
|
2001
|
+
:type group_reconciliation_run_request: GroupReconciliationRunRequest
|
2002
|
+
:param async_req: Whether to execute the request asynchronously.
|
2003
|
+
:type async_req: bool, optional
|
2004
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2005
|
+
:param opts: Configuration options for this request
|
2006
|
+
:type opts: ConfigurationOptions, optional
|
2007
|
+
:return: Returns the result object.
|
2008
|
+
If the method is called asynchronously,
|
2009
|
+
returns the request thread.
|
2010
|
+
:rtype: GroupReconciliationRunResponse
|
2011
|
+
"""
|
2012
|
+
kwargs['_return_http_data_only'] = True
|
2013
|
+
if '_preload_content' in kwargs:
|
2014
|
+
message = "Error! Please call the run_reconciliation_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
2015
|
+
raise ValueError(message)
|
2016
|
+
if async_req is not None:
|
2017
|
+
kwargs['async_req'] = async_req
|
2018
|
+
return self.run_reconciliation_with_http_info(scope, code, group_reconciliation_run_request, **kwargs) # noqa: E501
|
2019
|
+
|
2020
|
+
@validate_arguments
|
2021
|
+
def run_reconciliation_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the group reconciliation definition to use for the reconciliation.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to use for the reconciliation.")], group_reconciliation_run_request : Optional[GroupReconciliationRunRequest] = None, **kwargs) -> ApiResponse: # noqa: E501
|
2022
|
+
"""[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
|
2023
|
+
|
2024
|
+
Runs a Group Reconciliation using the definition specified by the Finbourne.Identifiers.Abstractions.Scope and Finbourne.Identifiers.Abstractions.Code Supports pagination. # noqa: E501
|
2025
|
+
This method makes a synchronous HTTP request by default. To make an
|
2026
|
+
asynchronous HTTP request, please pass async_req=True
|
2027
|
+
|
2028
|
+
>>> thread = api.run_reconciliation_with_http_info(scope, code, group_reconciliation_run_request, async_req=True)
|
2029
|
+
>>> result = thread.get()
|
2030
|
+
|
2031
|
+
:param scope: The scope of the group reconciliation definition to use for the reconciliation. (required)
|
2032
|
+
:type scope: str
|
2033
|
+
:param code: The code of the group reconciliation definition to use for the reconciliation. (required)
|
2034
|
+
:type code: str
|
2035
|
+
:param group_reconciliation_run_request:
|
2036
|
+
:type group_reconciliation_run_request: GroupReconciliationRunRequest
|
2037
|
+
:param async_req: Whether to execute the request asynchronously.
|
2038
|
+
:type async_req: bool, optional
|
2039
|
+
:param _preload_content: if False, the ApiResponse.data will
|
2040
|
+
be set to none and raw_data will store the
|
2041
|
+
HTTP response body without reading/decoding.
|
2042
|
+
Default is True.
|
2043
|
+
:type _preload_content: bool, optional
|
2044
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
2045
|
+
object with status code, headers, etc
|
2046
|
+
:type _return_http_data_only: bool, optional
|
2047
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
2048
|
+
:param opts: Configuration options for this request
|
2049
|
+
:type opts: ConfigurationOptions, optional
|
2050
|
+
:param _request_auth: set to override the auth_settings for an a single
|
2051
|
+
request; this effectively ignores the authentication
|
2052
|
+
in the spec for a single request.
|
2053
|
+
:type _request_auth: dict, optional
|
2054
|
+
:type _content_type: string, optional: force content-type for the request
|
2055
|
+
:return: Returns the result object.
|
2056
|
+
If the method is called asynchronously,
|
2057
|
+
returns the request thread.
|
2058
|
+
:rtype: tuple(GroupReconciliationRunResponse, status_code(int), headers(HTTPHeaderDict))
|
2059
|
+
"""
|
2060
|
+
|
2061
|
+
_params = locals()
|
2062
|
+
|
2063
|
+
_all_params = [
|
2064
|
+
'scope',
|
2065
|
+
'code',
|
2066
|
+
'group_reconciliation_run_request'
|
2067
|
+
]
|
2068
|
+
_all_params.extend(
|
2069
|
+
[
|
2070
|
+
'async_req',
|
2071
|
+
'_return_http_data_only',
|
2072
|
+
'_preload_content',
|
2073
|
+
'_request_timeout',
|
2074
|
+
'_request_auth',
|
2075
|
+
'_content_type',
|
2076
|
+
'_headers',
|
2077
|
+
'opts'
|
2078
|
+
]
|
2079
|
+
)
|
2080
|
+
|
2081
|
+
# validate the arguments
|
2082
|
+
for _key, _val in _params['kwargs'].items():
|
2083
|
+
if _key not in _all_params:
|
2084
|
+
raise ApiTypeError(
|
2085
|
+
"Got an unexpected keyword argument '%s'"
|
2086
|
+
" to method run_reconciliation" % _key
|
2087
|
+
)
|
2088
|
+
_params[_key] = _val
|
2089
|
+
del _params['kwargs']
|
2090
|
+
|
2091
|
+
_collection_formats = {}
|
2092
|
+
|
2093
|
+
# process the path parameters
|
2094
|
+
_path_params = {}
|
2095
|
+
if _params['scope']:
|
2096
|
+
_path_params['scope'] = _params['scope']
|
2097
|
+
|
2098
|
+
if _params['code']:
|
2099
|
+
_path_params['code'] = _params['code']
|
2100
|
+
|
2101
|
+
|
2102
|
+
# process the query parameters
|
2103
|
+
_query_params = []
|
2104
|
+
# process the header parameters
|
2105
|
+
_header_params = dict(_params.get('_headers', {}))
|
2106
|
+
# process the form parameters
|
2107
|
+
_form_params = []
|
2108
|
+
_files = {}
|
2109
|
+
# process the body parameter
|
2110
|
+
_body_params = None
|
2111
|
+
if _params['group_reconciliation_run_request'] is not None:
|
2112
|
+
_body_params = _params['group_reconciliation_run_request']
|
2113
|
+
|
2114
|
+
# set the HTTP header `Accept`
|
2115
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
2116
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
2117
|
+
|
2118
|
+
# set the HTTP header `Content-Type`
|
2119
|
+
_content_types_list = _params.get('_content_type',
|
2120
|
+
self.api_client.select_header_content_type(
|
2121
|
+
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
|
2122
|
+
if _content_types_list:
|
2123
|
+
_header_params['Content-Type'] = _content_types_list
|
2124
|
+
|
2125
|
+
# authentication setting
|
2126
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
2127
|
+
|
2128
|
+
_response_types_map = {
|
2129
|
+
'200': "GroupReconciliationRunResponse",
|
2130
|
+
'400': "LusidValidationProblemDetails",
|
2131
|
+
}
|
2132
|
+
|
2133
|
+
return self.api_client.call_api(
|
2134
|
+
'/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/$run', 'POST',
|
2135
|
+
_path_params,
|
2136
|
+
_query_params,
|
2137
|
+
_header_params,
|
2138
|
+
body=_body_params,
|
2139
|
+
post_params=_form_params,
|
2140
|
+
files=_files,
|
2141
|
+
response_types_map=_response_types_map,
|
2142
|
+
auth_settings=_auth_settings,
|
2143
|
+
async_req=_params.get('async_req'),
|
2144
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
2145
|
+
_preload_content=_params.get('_preload_content', True),
|
2146
|
+
_request_timeout=_params.get('_request_timeout'),
|
2147
|
+
opts=_params.get('opts'),
|
2148
|
+
collection_formats=_collection_formats,
|
2149
|
+
_request_auth=_params.get('_request_auth'))
|
2150
|
+
|
1424
2151
|
@overload
|
1425
2152
|
async def update_comparison_ruleset(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified comparison ruleset.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
|
1426
2153
|
...
|