lusid-sdk 2.1.405__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.
Files changed (294) hide show
  1. lusid/__init__.py +142 -8
  2. lusid/api/__init__.py +2 -2
  3. lusid/api/abor_api.py +126 -133
  4. lusid/api/abor_configuration_api.py +46 -45
  5. lusid/api/address_key_definition_api.py +28 -27
  6. lusid/api/aggregation_api.py +37 -36
  7. lusid/api/allocations_api.py +39 -38
  8. lusid/api/amortisation_rule_sets_api.py +55 -54
  9. lusid/api/application_metadata_api.py +28 -27
  10. lusid/api/blocks_api.py +37 -36
  11. lusid/api/calendars_api.py +469 -111
  12. lusid/api/chart_of_accounts_api.py +454 -279
  13. lusid/api/complex_market_data_api.py +37 -36
  14. lusid/api/compliance_api.py +136 -135
  15. lusid/api/configuration_recipe_api.py +100 -99
  16. lusid/api/conventions_api.py +109 -108
  17. lusid/api/corporate_action_sources_api.py +82 -81
  18. lusid/api/counterparties_api.py +73 -72
  19. lusid/api/custom_entities_api.py +102 -101
  20. lusid/api/custom_entity_definitions_api.py +37 -36
  21. lusid/api/custom_entity_types_api.py +37 -36
  22. lusid/api/cut_label_definitions_api.py +46 -45
  23. lusid/api/data_types_api.py +248 -72
  24. lusid/api/derived_transaction_portfolios_api.py +19 -18
  25. lusid/api/entities_api.py +431 -46
  26. lusid/api/executions_api.py +37 -36
  27. lusid/api/fee_types_api.py +55 -54
  28. lusid/api/{fund_configurations_api.py → fund_configuration_api.py} +222 -46
  29. lusid/api/funds_api.py +337 -162
  30. lusid/api/group_reconciliations_api.py +2182 -63
  31. lusid/api/instrument_event_types_api.py +64 -63
  32. lusid/api/instrument_events_api.py +46 -45
  33. lusid/api/instruments_api.py +374 -186
  34. lusid/api/legacy_compliance_api.py +73 -72
  35. lusid/api/legal_entities_api.py +167 -166
  36. lusid/api/order_graph_api.py +32 -31
  37. lusid/api/order_instructions_api.py +37 -36
  38. lusid/api/order_management_api.py +251 -90
  39. lusid/api/orders_api.py +37 -36
  40. lusid/api/packages_api.py +37 -36
  41. lusid/api/participations_api.py +37 -36
  42. lusid/api/persons_api.py +163 -162
  43. lusid/api/placements_api.py +37 -36
  44. lusid/api/portfolio_groups_api.py +235 -234
  45. lusid/api/portfolios_api.py +307 -309
  46. lusid/api/property_definitions_api.py +100 -99
  47. lusid/api/queryable_keys_api.py +10 -9
  48. lusid/api/quotes_api.py +82 -81
  49. lusid/api/reconciliations_api.py +136 -135
  50. lusid/api/reference_lists_api.py +39 -38
  51. lusid/api/reference_portfolio_api.py +213 -36
  52. lusid/api/relation_definitions_api.py +28 -27
  53. lusid/api/relations_api.py +19 -18
  54. lusid/api/relationship_definitions_api.py +46 -45
  55. lusid/api/relationships_api.py +19 -18
  56. lusid/api/schemas_api.py +37 -36
  57. lusid/api/scopes_api.py +19 -18
  58. lusid/api/scripted_translation_api.py +73 -72
  59. lusid/api/search_api.py +37 -36
  60. lusid/api/sequences_api.py +37 -36
  61. lusid/api/staged_modifications_api.py +37 -36
  62. lusid/api/staging_rule_set_api.py +46 -45
  63. lusid/api/structured_result_data_api.py +82 -81
  64. lusid/api/system_configuration_api.py +64 -63
  65. lusid/api/tax_rule_sets_api.py +46 -45
  66. lusid/api/transaction_configuration_api.py +100 -99
  67. lusid/api/transaction_fees_api.py +46 -45
  68. lusid/api/transaction_portfolios_api.py +771 -328
  69. lusid/api/translation_api.py +19 -18
  70. lusid/api/workspace_api.py +181 -180
  71. lusid/api_client.py +26 -17
  72. lusid/configuration.py +87 -2
  73. lusid/extensions/api_client.py +25 -17
  74. lusid/extensions/api_client_factory.py +14 -5
  75. lusid/extensions/api_configuration.py +50 -1
  76. lusid/extensions/configuration_loaders.py +39 -11
  77. lusid/extensions/configuration_options.py +67 -0
  78. lusid/extensions/rest.py +78 -26
  79. lusid/extensions/retry.py +109 -37
  80. lusid/models/__init__.py +140 -6
  81. lusid/models/access_metadata_value.py +1 -1
  82. lusid/models/accounting_method.py +7 -0
  83. lusid/models/accumulation_event.py +3 -3
  84. lusid/models/address_key_list.py +3 -3
  85. lusid/models/amortisation_event.py +3 -3
  86. lusid/models/amount.py +69 -0
  87. lusid/models/applicable_instrument_event.py +7 -2
  88. lusid/models/asset_leg.py +1 -1
  89. lusid/models/basket.py +3 -3
  90. lusid/models/batch_update_user_review_for_comparison_result_request.py +81 -0
  91. lusid/models/batch_update_user_review_for_comparison_result_response.py +146 -0
  92. lusid/models/batch_upsert_dates_for_calendar_response.py +146 -0
  93. lusid/models/batch_upsert_portfolio_access_metadata_request.py +27 -17
  94. lusid/models/batch_upsert_portfolio_access_metadata_response.py +56 -16
  95. lusid/models/{metadata_key_value.py → batch_upsert_portfolio_access_metadata_response_item.py} +15 -9
  96. lusid/models/bond.py +3 -3
  97. lusid/models/bond_coupon_event.py +10 -5
  98. lusid/models/bond_default_event.py +3 -3
  99. lusid/models/bond_principal_event.py +10 -5
  100. lusid/models/bonus_issue_event.py +166 -0
  101. lusid/models/{component_rule.py → break_code_source.py} +17 -21
  102. lusid/models/call_on_intermediate_securities_event.py +139 -0
  103. lusid/models/cancel_order_and_move_remaining_result.py +84 -0
  104. lusid/models/cancel_orders_and_move_remaining_request.py +83 -0
  105. lusid/models/cancel_orders_and_move_remaining_response.py +153 -0
  106. lusid/models/cap_floor.py +3 -3
  107. lusid/models/capital_distribution_event.py +3 -3
  108. lusid/models/cash.py +3 -3
  109. lusid/models/cash_dividend_event.py +3 -3
  110. lusid/models/cash_flow_event.py +3 -3
  111. lusid/models/cash_perpetual.py +3 -3
  112. lusid/models/cds_credit_event.py +6 -6
  113. lusid/models/cds_index.py +3 -3
  114. lusid/models/cdx_credit_event.py +6 -6
  115. lusid/models/change_interval.py +123 -0
  116. lusid/models/change_interval_with_order_management_detail.py +3 -3
  117. lusid/models/close_event.py +3 -3
  118. lusid/models/comparison_attribute_value_pair.py +71 -0
  119. lusid/models/complex_bond.py +3 -3
  120. lusid/models/component_transaction.py +10 -3
  121. lusid/models/contract_for_difference.py +3 -3
  122. lusid/models/create_derived_transaction_portfolio_request.py +3 -3
  123. lusid/models/create_group_reconciliation_definition_request.py +113 -0
  124. lusid/models/create_staging_rule_set_request.py +1 -6
  125. lusid/models/create_transaction_portfolio_request.py +3 -3
  126. lusid/models/credit_default_swap.py +3 -3
  127. lusid/models/credit_premium_cash_flow_event.py +3 -3
  128. lusid/models/custodian_account_request.py +1 -1
  129. lusid/models/custom_entity_entity.py +146 -0
  130. lusid/models/custom_entity_response.py +7 -1
  131. lusid/models/decimal_list.py +3 -3
  132. lusid/models/delete_instrument_properties_response.py +7 -1
  133. lusid/models/delete_instrument_response.py +7 -1
  134. lusid/models/delete_instruments_response.py +22 -1
  135. lusid/models/deleted_entity_response.py +7 -1
  136. lusid/models/diary_entry_request.py +10 -1
  137. lusid/models/dividend_option_event.py +3 -3
  138. lusid/models/dividend_reinvestment_event.py +9 -4
  139. lusid/models/effective_range.py +71 -0
  140. lusid/models/equity.py +3 -3
  141. lusid/models/equity_option.py +22 -7
  142. lusid/models/equity_swap.py +3 -3
  143. lusid/models/exchange_traded_option.py +3 -3
  144. lusid/models/exchange_traded_option_contract_details.py +1 -1
  145. lusid/models/exercise_event.py +3 -3
  146. lusid/models/exotic_instrument.py +3 -3
  147. lusid/models/expiry_event.py +3 -3
  148. lusid/models/fee.py +17 -10
  149. lusid/models/fee_request.py +20 -13
  150. lusid/models/fee_type.py +4 -4
  151. lusid/models/fee_type_request.py +3 -3
  152. lusid/models/fixed_leg.py +3 -3
  153. lusid/models/fixed_schedule.py +3 -3
  154. lusid/models/flexible_loan.py +3 -3
  155. lusid/models/float_schedule.py +4 -4
  156. lusid/models/floating_leg.py +3 -3
  157. lusid/models/flow_conventions.py +7 -1
  158. lusid/models/forward_rate_agreement.py +3 -3
  159. lusid/models/fund_configuration.py +44 -17
  160. lusid/models/fund_configuration_request.py +31 -19
  161. lusid/models/fund_id_list.py +99 -0
  162. lusid/models/fund_share_class.py +23 -8
  163. lusid/models/funding_leg.py +3 -3
  164. lusid/models/future.py +3 -3
  165. lusid/models/future_expiry_event.py +3 -3
  166. lusid/models/fx_forward.py +3 -3
  167. lusid/models/fx_forward_settlement_event.py +3 -3
  168. lusid/models/fx_option.py +3 -3
  169. lusid/models/fx_swap.py +3 -3
  170. lusid/models/group_reconciliation_aggregate_attribute_rule.py +2 -2
  171. lusid/models/group_reconciliation_aggregate_attribute_values.py +86 -0
  172. lusid/models/group_reconciliation_aggregate_comparison_rule_operand.py +1 -1
  173. lusid/models/group_reconciliation_comparison_result.py +148 -0
  174. lusid/models/group_reconciliation_core_attribute_values.py +86 -0
  175. lusid/models/group_reconciliation_core_comparison_rule_operand.py +1 -1
  176. lusid/models/group_reconciliation_date_pair.py +81 -0
  177. lusid/models/group_reconciliation_dates.py +78 -0
  178. lusid/models/group_reconciliation_definition.py +136 -0
  179. lusid/models/group_reconciliation_definition_comparison_ruleset_ids.py +83 -0
  180. lusid/models/group_reconciliation_definition_currencies.py +71 -0
  181. lusid/models/group_reconciliation_definition_portfolio_entity_ids.py +86 -0
  182. lusid/models/group_reconciliation_definition_recipe_ids.py +78 -0
  183. lusid/models/group_reconciliation_instance_id.py +71 -0
  184. lusid/models/group_reconciliation_result_statuses.py +89 -0
  185. lusid/models/group_reconciliation_result_types.py +96 -0
  186. lusid/models/group_reconciliation_review_statuses.py +96 -0
  187. lusid/models/group_reconciliation_run_details.py +76 -0
  188. lusid/models/group_reconciliation_run_request.py +75 -0
  189. lusid/models/{metadata_key_value_response.py → group_reconciliation_run_response.py} +20 -29
  190. lusid/models/group_reconciliation_summary.py +121 -0
  191. lusid/models/group_reconciliation_user_review.py +112 -0
  192. lusid/models/group_reconciliation_user_review_add.py +88 -0
  193. lusid/models/group_reconciliation_user_review_break_code.py +80 -0
  194. lusid/models/group_reconciliation_user_review_comment.py +80 -0
  195. lusid/models/group_reconciliation_user_review_match_key.py +80 -0
  196. lusid/models/group_reconciliation_user_review_remove.py +88 -0
  197. lusid/models/holding_contributor.py +11 -4
  198. lusid/models/holding_ids_request.py +69 -0
  199. lusid/models/inflation_leg.py +3 -3
  200. lusid/models/inflation_linked_bond.py +3 -3
  201. lusid/models/inflation_swap.py +3 -3
  202. lusid/models/informational_error_event.py +3 -3
  203. lusid/models/informational_event.py +3 -3
  204. lusid/models/instrument.py +7 -1
  205. lusid/models/instrument_definition.py +8 -2
  206. lusid/models/instrument_event.py +17 -5
  207. lusid/models/instrument_event_holder.py +9 -1
  208. lusid/models/instrument_event_type.py +12 -0
  209. lusid/models/instrument_leg.py +3 -3
  210. lusid/models/instrument_list.py +3 -3
  211. lusid/models/instrument_type.py +2 -0
  212. lusid/models/interest_rate_swap.py +3 -3
  213. lusid/models/interest_rate_swaption.py +3 -3
  214. lusid/models/intermediate_securities_distribution_event.py +140 -0
  215. lusid/models/lapse_election.py +73 -0
  216. lusid/models/loan_facility.py +97 -0
  217. lusid/models/lusid_instrument.py +7 -5
  218. lusid/models/market_data_key_rule.py +5 -3
  219. lusid/models/market_data_specific_rule.py +5 -3
  220. lusid/models/mastered_instrument.py +139 -0
  221. lusid/models/maturity_event.py +3 -3
  222. lusid/models/mbs_coupon_event.py +102 -0
  223. lusid/models/mbs_interest_deferral_event.py +102 -0
  224. lusid/models/mbs_interest_shortfall_event.py +102 -0
  225. lusid/models/mbs_principal_event.py +102 -0
  226. lusid/models/mbs_principal_write_off_event.py +102 -0
  227. lusid/models/merger_event.py +22 -22
  228. lusid/models/new_instrument.py +1 -1
  229. lusid/models/open_event.py +3 -3
  230. lusid/models/option_exercise_cash_event.py +144 -0
  231. lusid/models/option_exercise_election.py +73 -0
  232. lusid/models/option_exercise_physical_event.py +149 -0
  233. lusid/models/output_transaction.py +9 -2
  234. lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +113 -0
  235. lusid/models/paged_resource_list_of_group_reconciliation_comparison_ruleset.py +113 -0
  236. lusid/models/paged_resource_list_of_group_reconciliation_definition.py +113 -0
  237. lusid/models/portfolio.py +3 -3
  238. lusid/models/portfolio_details.py +3 -3
  239. lusid/models/portfolio_group_id_list.py +3 -3
  240. lusid/models/portfolio_id_list.py +3 -3
  241. lusid/models/portfolio_without_href.py +3 -3
  242. lusid/models/pricing_options.py +8 -2
  243. lusid/models/property_list.py +3 -3
  244. lusid/models/protection_payout_cash_flow_event.py +102 -0
  245. lusid/models/raw_vendor_event.py +3 -3
  246. lusid/models/reference_instrument.py +3 -3
  247. lusid/models/reference_list.py +6 -5
  248. lusid/models/reference_list_type.py +1 -0
  249. lusid/models/repo.py +3 -3
  250. lusid/models/reset_event.py +3 -3
  251. lusid/models/resource_list_of_change_interval.py +113 -0
  252. lusid/models/resource_list_of_output_transaction.py +113 -0
  253. lusid/models/return_zero_pv_options.py +69 -0
  254. lusid/models/reverse_stock_split_event.py +21 -7
  255. lusid/models/scrip_dividend_event.py +3 -3
  256. lusid/models/settlement_cycle.py +79 -0
  257. lusid/models/share_class_dealing_breakdown.py +3 -2
  258. lusid/models/share_class_details.py +18 -1
  259. lusid/models/simple_cash_flow_loan.py +3 -3
  260. lusid/models/simple_instrument.py +3 -3
  261. lusid/models/simple_rounding_convention.py +76 -0
  262. lusid/models/spin_off_event.py +3 -3
  263. lusid/models/staged_modification_effective_range.py +2 -2
  264. lusid/models/stock_dividend_event.py +20 -6
  265. lusid/models/stock_split_event.py +3 -3
  266. lusid/models/string_list.py +3 -3
  267. lusid/models/swap_cash_flow_event.py +3 -3
  268. lusid/models/swap_principal_event.py +3 -3
  269. lusid/models/target_tax_lot.py +23 -2
  270. lusid/models/target_tax_lot_request.py +23 -2
  271. lusid/models/tender_event.py +172 -0
  272. lusid/models/term_deposit.py +3 -3
  273. lusid/models/total_return_swap.py +4 -4
  274. lusid/models/transaction.py +9 -2
  275. lusid/models/transaction_date_windows.py +85 -0
  276. lusid/models/transaction_price.py +3 -3
  277. lusid/models/transaction_price_type.py +2 -0
  278. lusid/models/transaction_request.py +9 -2
  279. lusid/models/transition_event.py +3 -3
  280. lusid/models/trigger_event.py +3 -3
  281. lusid/models/update_fee_type_request.py +4 -4
  282. lusid/models/update_group_reconciliation_comparison_ruleset_request.py +91 -0
  283. lusid/models/update_group_reconciliation_definition_request.py +107 -0
  284. lusid/models/update_reference_data_request.py +87 -0
  285. lusid/models/update_staging_rule_set_request.py +1 -6
  286. lusid/models/upsert_custom_entities_response.py +20 -1
  287. lusid/models/upsert_reference_portfolio_constituent_properties_request.py +84 -0
  288. lusid/models/upsert_reference_portfolio_constituent_properties_response.py +115 -0
  289. lusid/models/valuation_point_data_query_parameters.py +3 -3
  290. lusid/models/valuation_point_data_response.py +8 -13
  291. lusid/rest.py +70 -20
  292. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/METADATA +118 -26
  293. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/RECORD +294 -226
  294. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/WHEEL +0 -0
@@ -22,12 +22,25 @@ from typing import overload, Optional, Union, Awaitable
22
22
  from typing_extensions import Annotated
23
23
  from datetime import datetime
24
24
 
25
- from pydantic.v1 import Field, constr, validator
25
+ 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
32
+ from lusid.models.create_group_reconciliation_definition_request import CreateGroupReconciliationDefinitionRequest
33
+ from lusid.models.deleted_entity_response import DeletedEntityResponse
34
+ from lusid.models.group_reconciliation_comparison_result import GroupReconciliationComparisonResult
30
35
  from lusid.models.group_reconciliation_comparison_ruleset import GroupReconciliationComparisonRuleset
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
40
+ from lusid.models.paged_resource_list_of_group_reconciliation_comparison_ruleset import PagedResourceListOfGroupReconciliationComparisonRuleset
41
+ from lusid.models.paged_resource_list_of_group_reconciliation_definition import PagedResourceListOfGroupReconciliationDefinition
42
+ from lusid.models.update_group_reconciliation_comparison_ruleset_request import UpdateGroupReconciliationComparisonRulesetRequest
43
+ from lusid.models.update_group_reconciliation_definition_request import UpdateGroupReconciliationDefinitionRequest
31
44
 
32
45
  from lusid.api_client import ApiClient
33
46
  from lusid.api_response import ApiResponse
@@ -35,6 +48,7 @@ from lusid.exceptions import ( # noqa: F401
35
48
  ApiTypeError,
36
49
  ApiValueError
37
50
  )
51
+ from lusid.extensions.configuration_options import ConfigurationOptions
38
52
 
39
53
 
40
54
  class GroupReconciliationsApi:
@@ -49,6 +63,188 @@ class GroupReconciliationsApi:
49
63
  api_client = ApiClient.get_default()
50
64
  self.api_client = api_client
51
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
+
52
248
  @overload
53
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
54
250
  ...
@@ -72,10 +268,9 @@ class GroupReconciliationsApi:
72
268
  :type create_group_reconciliation_comparison_ruleset_request: CreateGroupReconciliationComparisonRulesetRequest
73
269
  :param async_req: Whether to execute the request asynchronously.
74
270
  :type async_req: bool, optional
75
- :param _request_timeout: timeout setting for this request.
76
- If one number provided, it will be total request
77
- timeout. It can also be a pair (tuple) of
78
- (connection, read) timeouts.
271
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
272
+ :param opts: Configuration options for this request
273
+ :type opts: ConfigurationOptions, optional
79
274
  :return: Returns the result object.
80
275
  If the method is called asynchronously,
81
276
  returns the request thread.
@@ -112,10 +307,9 @@ class GroupReconciliationsApi:
112
307
  :param _return_http_data_only: response data instead of ApiResponse
113
308
  object with status code, headers, etc
114
309
  :type _return_http_data_only: bool, optional
115
- :param _request_timeout: timeout setting for this request. If one
116
- number provided, it will be total request
117
- timeout. It can also be a pair (tuple) of
118
- (connection, read) timeouts.
310
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
311
+ :param opts: Configuration options for this request
312
+ :type opts: ConfigurationOptions, optional
119
313
  :param _request_auth: set to override the auth_settings for an a single
120
314
  request; this effectively ignores the authentication
121
315
  in the spec for a single request.
@@ -140,7 +334,8 @@ class GroupReconciliationsApi:
140
334
  '_request_timeout',
141
335
  '_request_auth',
142
336
  '_content_type',
143
- '_headers'
337
+ '_headers',
338
+ 'opts'
144
339
  ]
145
340
  )
146
341
 
@@ -204,70 +399,62 @@ class GroupReconciliationsApi:
204
399
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
205
400
  _preload_content=_params.get('_preload_content', True),
206
401
  _request_timeout=_params.get('_request_timeout'),
402
+ opts=_params.get('opts'),
207
403
  collection_formats=_collection_formats,
208
404
  _request_auth=_params.get('_request_auth'))
209
405
 
210
406
  @overload
211
- 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
407
+ async def create_group_reconciliation_definition(self, create_group_reconciliation_definition_request : Annotated[Optional[CreateGroupReconciliationDefinitionRequest], Field(description="The definition Group Reconciliation Definition details")] = None, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
212
408
  ...
213
409
 
214
410
  @overload
215
- 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
411
+ def create_group_reconciliation_definition(self, create_group_reconciliation_definition_request : Annotated[Optional[CreateGroupReconciliationDefinitionRequest], Field(description="The definition Group Reconciliation Definition details")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
216
412
  ...
217
413
 
218
414
  @validate_arguments
219
- 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
220
- """[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code # noqa: E501
415
+ def create_group_reconciliation_definition(self, create_group_reconciliation_definition_request : Annotated[Optional[CreateGroupReconciliationDefinitionRequest], Field(description="The definition Group Reconciliation Definition details")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationDefinition, Awaitable[GroupReconciliationDefinition]]: # noqa: E501
416
+ """[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
221
417
 
222
- Retrieves one Group Reconciliation Comparison Ruleset by scope and code # noqa: E501
418
+ Creates a Group Reconciliation Definition # noqa: E501
223
419
  This method makes a synchronous HTTP request by default. To make an
224
420
  asynchronous HTTP request, please pass async_req=True
225
421
 
226
- >>> thread = api.get_comparison_ruleset(scope, code, as_at, async_req=True)
422
+ >>> thread = api.create_group_reconciliation_definition(create_group_reconciliation_definition_request, async_req=True)
227
423
  >>> result = thread.get()
228
424
 
229
- :param scope: The scope of the specified comparison ruleset. (required)
230
- :type scope: str
231
- :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
232
- :type code: str
233
- :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.
234
- :type as_at: datetime
425
+ :param create_group_reconciliation_definition_request: The definition Group Reconciliation Definition details
426
+ :type create_group_reconciliation_definition_request: CreateGroupReconciliationDefinitionRequest
235
427
  :param async_req: Whether to execute the request asynchronously.
236
428
  :type async_req: bool, optional
237
- :param _request_timeout: timeout setting for this request.
238
- If one number provided, it will be total request
239
- timeout. It can also be a pair (tuple) of
240
- (connection, read) timeouts.
429
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
430
+ :param opts: Configuration options for this request
431
+ :type opts: ConfigurationOptions, optional
241
432
  :return: Returns the result object.
242
433
  If the method is called asynchronously,
243
434
  returns the request thread.
244
- :rtype: GroupReconciliationComparisonRuleset
435
+ :rtype: GroupReconciliationDefinition
245
436
  """
246
437
  kwargs['_return_http_data_only'] = True
247
438
  if '_preload_content' in kwargs:
248
- 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
439
+ message = "Error! Please call the create_group_reconciliation_definition_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
249
440
  raise ValueError(message)
250
441
  if async_req is not None:
251
442
  kwargs['async_req'] = async_req
252
- return self.get_comparison_ruleset_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
443
+ return self.create_group_reconciliation_definition_with_http_info(create_group_reconciliation_definition_request, **kwargs) # noqa: E501
253
444
 
254
445
  @validate_arguments
255
- 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
256
- """[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code # noqa: E501
446
+ def create_group_reconciliation_definition_with_http_info(self, create_group_reconciliation_definition_request : Annotated[Optional[CreateGroupReconciliationDefinitionRequest], Field(description="The definition Group Reconciliation Definition details")] = None, **kwargs) -> ApiResponse: # noqa: E501
447
+ """[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
257
448
 
258
- Retrieves one Group Reconciliation Comparison Ruleset by scope and code # noqa: E501
449
+ Creates a Group Reconciliation Definition # noqa: E501
259
450
  This method makes a synchronous HTTP request by default. To make an
260
451
  asynchronous HTTP request, please pass async_req=True
261
452
 
262
- >>> thread = api.get_comparison_ruleset_with_http_info(scope, code, as_at, async_req=True)
453
+ >>> thread = api.create_group_reconciliation_definition_with_http_info(create_group_reconciliation_definition_request, async_req=True)
263
454
  >>> result = thread.get()
264
455
 
265
- :param scope: The scope of the specified comparison ruleset. (required)
266
- :type scope: str
267
- :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
268
- :type code: str
269
- :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.
270
- :type as_at: datetime
456
+ :param create_group_reconciliation_definition_request: The definition Group Reconciliation Definition details
457
+ :type create_group_reconciliation_definition_request: CreateGroupReconciliationDefinitionRequest
271
458
  :param async_req: Whether to execute the request asynchronously.
272
459
  :type async_req: bool, optional
273
460
  :param _preload_content: if False, the ApiResponse.data will
@@ -278,10 +465,9 @@ class GroupReconciliationsApi:
278
465
  :param _return_http_data_only: response data instead of ApiResponse
279
466
  object with status code, headers, etc
280
467
  :type _return_http_data_only: bool, optional
281
- :param _request_timeout: timeout setting for this request. If one
282
- number provided, it will be total request
283
- timeout. It can also be a pair (tuple) of
284
- (connection, read) timeouts.
468
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
469
+ :param opts: Configuration options for this request
470
+ :type opts: ConfigurationOptions, optional
285
471
  :param _request_auth: set to override the auth_settings for an a single
286
472
  request; this effectively ignores the authentication
287
473
  in the spec for a single request.
@@ -290,15 +476,13 @@ class GroupReconciliationsApi:
290
476
  :return: Returns the result object.
291
477
  If the method is called asynchronously,
292
478
  returns the request thread.
293
- :rtype: tuple(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
479
+ :rtype: tuple(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
294
480
  """
295
481
 
296
482
  _params = locals()
297
483
 
298
484
  _all_params = [
299
- 'scope',
300
- 'code',
301
- 'as_at'
485
+ 'create_group_reconciliation_definition_request'
302
486
  ]
303
487
  _all_params.extend(
304
488
  [
@@ -308,7 +492,8 @@ class GroupReconciliationsApi:
308
492
  '_request_timeout',
309
493
  '_request_auth',
310
494
  '_content_type',
311
- '_headers'
495
+ '_headers',
496
+ 'opts'
312
497
  ]
313
498
  )
314
499
 
@@ -317,7 +502,7 @@ class GroupReconciliationsApi:
317
502
  if _key not in _all_params:
318
503
  raise ApiTypeError(
319
504
  "Got an unexpected keyword argument '%s'"
320
- " to method get_comparison_ruleset" % _key
505
+ " to method create_group_reconciliation_definition" % _key
321
506
  )
322
507
  _params[_key] = _val
323
508
  del _params['kwargs']
@@ -326,21 +511,9 @@ class GroupReconciliationsApi:
326
511
 
327
512
  # process the path parameters
328
513
  _path_params = {}
329
- if _params['scope']:
330
- _path_params['scope'] = _params['scope']
331
-
332
- if _params['code']:
333
- _path_params['code'] = _params['code']
334
-
335
514
 
336
515
  # process the query parameters
337
516
  _query_params = []
338
- if _params.get('as_at') is not None: # noqa: E501
339
- if isinstance(_params['as_at'], datetime):
340
- _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
341
- else:
342
- _query_params.append(('asAt', _params['as_at']))
343
-
344
517
  # process the header parameters
345
518
  _header_params = dict(_params.get('_headers', {}))
346
519
  # process the form parameters
@@ -348,20 +521,1965 @@ class GroupReconciliationsApi:
348
521
  _files = {}
349
522
  # process the body parameter
350
523
  _body_params = None
524
+ if _params['create_group_reconciliation_definition_request'] is not None:
525
+ _body_params = _params['create_group_reconciliation_definition_request']
526
+
351
527
  # set the HTTP header `Accept`
352
528
  _header_params['Accept'] = self.api_client.select_header_accept(
353
529
  ['text/plain', 'application/json', 'text/json']) # noqa: E501
354
530
 
531
+ # set the HTTP header `Content-Type`
532
+ _content_types_list = _params.get('_content_type',
533
+ self.api_client.select_header_content_type(
534
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
535
+ if _content_types_list:
536
+ _header_params['Content-Type'] = _content_types_list
537
+
355
538
  # authentication setting
356
539
  _auth_settings = ['oauth2'] # noqa: E501
357
540
 
358
541
  _response_types_map = {
359
- '200': "GroupReconciliationComparisonRuleset",
542
+ '201': "GroupReconciliationDefinition",
360
543
  '400': "LusidValidationProblemDetails",
361
544
  }
362
545
 
363
546
  return self.api_client.call_api(
364
- '/api/reconciliations/comparisonrulesets/{scope}/{code}', 'GET',
547
+ '/api/reconciliations/groupreconciliationdefinitions', 'POST',
548
+ _path_params,
549
+ _query_params,
550
+ _header_params,
551
+ body=_body_params,
552
+ post_params=_form_params,
553
+ files=_files,
554
+ response_types_map=_response_types_map,
555
+ auth_settings=_auth_settings,
556
+ async_req=_params.get('async_req'),
557
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
558
+ _preload_content=_params.get('_preload_content', True),
559
+ _request_timeout=_params.get('_request_timeout'),
560
+ opts=_params.get('opts'),
561
+ collection_formats=_collection_formats,
562
+ _request_auth=_params.get('_request_auth'))
563
+
564
+ @overload
565
+ async def delete_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.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
566
+ ...
567
+
568
+ @overload
569
+ def delete_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.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
570
+ ...
571
+
572
+ @validate_arguments
573
+ def delete_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.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
574
+ """[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
575
+
576
+ The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
577
+ This method makes a synchronous HTTP request by default. To make an
578
+ asynchronous HTTP request, please pass async_req=True
579
+
580
+ >>> thread = api.delete_comparison_ruleset(scope, code, async_req=True)
581
+ >>> result = thread.get()
582
+
583
+ :param scope: The scope of the specified comparison ruleset. (required)
584
+ :type scope: str
585
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
586
+ :type code: str
587
+ :param async_req: Whether to execute the request asynchronously.
588
+ :type async_req: bool, optional
589
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
590
+ :param opts: Configuration options for this request
591
+ :type opts: ConfigurationOptions, optional
592
+ :return: Returns the result object.
593
+ If the method is called asynchronously,
594
+ returns the request thread.
595
+ :rtype: DeletedEntityResponse
596
+ """
597
+ kwargs['_return_http_data_only'] = True
598
+ if '_preload_content' in kwargs:
599
+ message = "Error! Please call the delete_comparison_ruleset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
600
+ raise ValueError(message)
601
+ if async_req is not None:
602
+ kwargs['async_req'] = async_req
603
+ return self.delete_comparison_ruleset_with_http_info(scope, code, **kwargs) # noqa: E501
604
+
605
+ @validate_arguments
606
+ def delete_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.")], **kwargs) -> ApiResponse: # noqa: E501
607
+ """[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
608
+
609
+ The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
610
+ This method makes a synchronous HTTP request by default. To make an
611
+ asynchronous HTTP request, please pass async_req=True
612
+
613
+ >>> thread = api.delete_comparison_ruleset_with_http_info(scope, code, async_req=True)
614
+ >>> result = thread.get()
615
+
616
+ :param scope: The scope of the specified comparison ruleset. (required)
617
+ :type scope: str
618
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
619
+ :type code: str
620
+ :param async_req: Whether to execute the request asynchronously.
621
+ :type async_req: bool, optional
622
+ :param _preload_content: if False, the ApiResponse.data will
623
+ be set to none and raw_data will store the
624
+ HTTP response body without reading/decoding.
625
+ Default is True.
626
+ :type _preload_content: bool, optional
627
+ :param _return_http_data_only: response data instead of ApiResponse
628
+ object with status code, headers, etc
629
+ :type _return_http_data_only: bool, optional
630
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
631
+ :param opts: Configuration options for this request
632
+ :type opts: ConfigurationOptions, optional
633
+ :param _request_auth: set to override the auth_settings for an a single
634
+ request; this effectively ignores the authentication
635
+ in the spec for a single request.
636
+ :type _request_auth: dict, optional
637
+ :type _content_type: string, optional: force content-type for the request
638
+ :return: Returns the result object.
639
+ If the method is called asynchronously,
640
+ returns the request thread.
641
+ :rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
642
+ """
643
+
644
+ _params = locals()
645
+
646
+ _all_params = [
647
+ 'scope',
648
+ 'code'
649
+ ]
650
+ _all_params.extend(
651
+ [
652
+ 'async_req',
653
+ '_return_http_data_only',
654
+ '_preload_content',
655
+ '_request_timeout',
656
+ '_request_auth',
657
+ '_content_type',
658
+ '_headers',
659
+ 'opts'
660
+ ]
661
+ )
662
+
663
+ # validate the arguments
664
+ for _key, _val in _params['kwargs'].items():
665
+ if _key not in _all_params:
666
+ raise ApiTypeError(
667
+ "Got an unexpected keyword argument '%s'"
668
+ " to method delete_comparison_ruleset" % _key
669
+ )
670
+ _params[_key] = _val
671
+ del _params['kwargs']
672
+
673
+ _collection_formats = {}
674
+
675
+ # process the path parameters
676
+ _path_params = {}
677
+ if _params['scope']:
678
+ _path_params['scope'] = _params['scope']
679
+
680
+ if _params['code']:
681
+ _path_params['code'] = _params['code']
682
+
683
+
684
+ # process the query parameters
685
+ _query_params = []
686
+ # process the header parameters
687
+ _header_params = dict(_params.get('_headers', {}))
688
+ # process the form parameters
689
+ _form_params = []
690
+ _files = {}
691
+ # process the body parameter
692
+ _body_params = None
693
+ # set the HTTP header `Accept`
694
+ _header_params['Accept'] = self.api_client.select_header_accept(
695
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
696
+
697
+ # authentication setting
698
+ _auth_settings = ['oauth2'] # noqa: E501
699
+
700
+ _response_types_map = {
701
+ '200': "DeletedEntityResponse",
702
+ '400': "LusidValidationProblemDetails",
703
+ }
704
+
705
+ return self.api_client.call_api(
706
+ '/api/reconciliations/comparisonrulesets/{scope}/{code}', 'DELETE',
707
+ _path_params,
708
+ _query_params,
709
+ _header_params,
710
+ body=_body_params,
711
+ post_params=_form_params,
712
+ files=_files,
713
+ response_types_map=_response_types_map,
714
+ auth_settings=_auth_settings,
715
+ async_req=_params.get('async_req'),
716
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
717
+ _preload_content=_params.get('_preload_content', True),
718
+ _request_timeout=_params.get('_request_timeout'),
719
+ opts=_params.get('opts'),
720
+ collection_formats=_collection_formats,
721
+ _request_auth=_params.get('_request_auth'))
722
+
723
+ @overload
724
+ async def delete_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 delete.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
725
+ ...
726
+
727
+ @overload
728
+ def delete_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 delete.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
729
+ ...
730
+
731
+ @validate_arguments
732
+ def delete_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 delete.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
733
+ """[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
734
+
735
+ Delete the group reconciliation definition. # noqa: E501
736
+ This method makes a synchronous HTTP request by default. To make an
737
+ asynchronous HTTP request, please pass async_req=True
738
+
739
+ >>> thread = api.delete_group_reconciliation_definition(scope, code, async_req=True)
740
+ >>> result = thread.get()
741
+
742
+ :param scope: The scope of the group reconciliation definition to delete. (required)
743
+ :type scope: str
744
+ :param code: The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete. (required)
745
+ :type code: str
746
+ :param async_req: Whether to execute the request asynchronously.
747
+ :type async_req: bool, optional
748
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
749
+ :param opts: Configuration options for this request
750
+ :type opts: ConfigurationOptions, optional
751
+ :return: Returns the result object.
752
+ If the method is called asynchronously,
753
+ returns the request thread.
754
+ :rtype: DeletedEntityResponse
755
+ """
756
+ kwargs['_return_http_data_only'] = True
757
+ if '_preload_content' in kwargs:
758
+ message = "Error! Please call the delete_group_reconciliation_definition_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
759
+ raise ValueError(message)
760
+ if async_req is not None:
761
+ kwargs['async_req'] = async_req
762
+ return self.delete_group_reconciliation_definition_with_http_info(scope, code, **kwargs) # noqa: E501
763
+
764
+ @validate_arguments
765
+ def delete_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 delete.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete.")], **kwargs) -> ApiResponse: # noqa: E501
766
+ """[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
767
+
768
+ Delete the group reconciliation definition. # noqa: E501
769
+ This method makes a synchronous HTTP request by default. To make an
770
+ asynchronous HTTP request, please pass async_req=True
771
+
772
+ >>> thread = api.delete_group_reconciliation_definition_with_http_info(scope, code, async_req=True)
773
+ >>> result = thread.get()
774
+
775
+ :param scope: The scope of the group reconciliation definition to delete. (required)
776
+ :type scope: str
777
+ :param code: The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete. (required)
778
+ :type code: str
779
+ :param async_req: Whether to execute the request asynchronously.
780
+ :type async_req: bool, optional
781
+ :param _preload_content: if False, the ApiResponse.data will
782
+ be set to none and raw_data will store the
783
+ HTTP response body without reading/decoding.
784
+ Default is True.
785
+ :type _preload_content: bool, optional
786
+ :param _return_http_data_only: response data instead of ApiResponse
787
+ object with status code, headers, etc
788
+ :type _return_http_data_only: bool, optional
789
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
790
+ :param opts: Configuration options for this request
791
+ :type opts: ConfigurationOptions, optional
792
+ :param _request_auth: set to override the auth_settings for an a single
793
+ request; this effectively ignores the authentication
794
+ in the spec for a single request.
795
+ :type _request_auth: dict, optional
796
+ :type _content_type: string, optional: force content-type for the request
797
+ :return: Returns the result object.
798
+ If the method is called asynchronously,
799
+ returns the request thread.
800
+ :rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
801
+ """
802
+
803
+ _params = locals()
804
+
805
+ _all_params = [
806
+ 'scope',
807
+ 'code'
808
+ ]
809
+ _all_params.extend(
810
+ [
811
+ 'async_req',
812
+ '_return_http_data_only',
813
+ '_preload_content',
814
+ '_request_timeout',
815
+ '_request_auth',
816
+ '_content_type',
817
+ '_headers',
818
+ 'opts'
819
+ ]
820
+ )
821
+
822
+ # validate the arguments
823
+ for _key, _val in _params['kwargs'].items():
824
+ if _key not in _all_params:
825
+ raise ApiTypeError(
826
+ "Got an unexpected keyword argument '%s'"
827
+ " to method delete_group_reconciliation_definition" % _key
828
+ )
829
+ _params[_key] = _val
830
+ del _params['kwargs']
831
+
832
+ _collection_formats = {}
833
+
834
+ # process the path parameters
835
+ _path_params = {}
836
+ if _params['scope']:
837
+ _path_params['scope'] = _params['scope']
838
+
839
+ if _params['code']:
840
+ _path_params['code'] = _params['code']
841
+
842
+
843
+ # process the query parameters
844
+ _query_params = []
845
+ # process the header parameters
846
+ _header_params = dict(_params.get('_headers', {}))
847
+ # process the form parameters
848
+ _form_params = []
849
+ _files = {}
850
+ # process the body parameter
851
+ _body_params = None
852
+ # set the HTTP header `Accept`
853
+ _header_params['Accept'] = self.api_client.select_header_accept(
854
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
855
+
856
+ # authentication setting
857
+ _auth_settings = ['oauth2'] # noqa: E501
858
+
859
+ _response_types_map = {
860
+ '200': "DeletedEntityResponse",
861
+ '400': "LusidValidationProblemDetails",
862
+ }
863
+
864
+ return self.api_client.call_api(
865
+ '/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}', 'DELETE',
866
+ _path_params,
867
+ _query_params,
868
+ _header_params,
869
+ body=_body_params,
870
+ post_params=_form_params,
871
+ files=_files,
872
+ response_types_map=_response_types_map,
873
+ auth_settings=_auth_settings,
874
+ async_req=_params.get('async_req'),
875
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
876
+ _preload_content=_params.get('_preload_content', True),
877
+ _request_timeout=_params.get('_request_timeout'),
878
+ opts=_params.get('opts'),
879
+ collection_formats=_collection_formats,
880
+ _request_auth=_params.get('_request_auth'))
881
+
882
+ @overload
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
884
+ ...
885
+
886
+ @overload
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
888
+ ...
889
+
890
+ @validate_arguments
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
893
+
894
+ Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
895
+ This method makes a synchronous HTTP request by default. To make an
896
+ asynchronous HTTP request, please pass async_req=True
897
+
898
+ >>> thread = api.get_comparison_result(scope, code, result_id, as_at, async_req=True)
899
+ >>> result = thread.get()
900
+
901
+ :param scope: The scope of the specified comparison result and its related reconciliation definition. (required)
902
+ :type scope: str
903
+ :param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
904
+ :type code: str
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.
908
+ :type as_at: datetime
909
+ :param async_req: Whether to execute the request asynchronously.
910
+ :type async_req: bool, optional
911
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
912
+ :param opts: Configuration options for this request
913
+ :type opts: ConfigurationOptions, optional
914
+ :return: Returns the result object.
915
+ If the method is called asynchronously,
916
+ returns the request thread.
917
+ :rtype: GroupReconciliationComparisonResult
918
+ """
919
+ kwargs['_return_http_data_only'] = True
920
+ if '_preload_content' in kwargs:
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
922
+ raise ValueError(message)
923
+ if async_req is not None:
924
+ kwargs['async_req'] = async_req
925
+ return self.get_comparison_result_with_http_info(scope, code, result_id, as_at, **kwargs) # noqa: E501
926
+
927
+ @validate_arguments
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
930
+
931
+ Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # noqa: E501
932
+ This method makes a synchronous HTTP request by default. To make an
933
+ asynchronous HTTP request, please pass async_req=True
934
+
935
+ >>> thread = api.get_comparison_result_with_http_info(scope, code, result_id, as_at, async_req=True)
936
+ >>> result = thread.get()
937
+
938
+ :param scope: The scope of the specified comparison result and its related reconciliation definition. (required)
939
+ :type scope: str
940
+ :param code: The code of the reconciliation definition that was used to produce the reconciliation result. (required)
941
+ :type code: str
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.
945
+ :type as_at: datetime
946
+ :param async_req: Whether to execute the request asynchronously.
947
+ :type async_req: bool, optional
948
+ :param _preload_content: if False, the ApiResponse.data will
949
+ be set to none and raw_data will store the
950
+ HTTP response body without reading/decoding.
951
+ Default is True.
952
+ :type _preload_content: bool, optional
953
+ :param _return_http_data_only: response data instead of ApiResponse
954
+ object with status code, headers, etc
955
+ :type _return_http_data_only: bool, optional
956
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
957
+ :param opts: Configuration options for this request
958
+ :type opts: ConfigurationOptions, optional
959
+ :param _request_auth: set to override the auth_settings for an a single
960
+ request; this effectively ignores the authentication
961
+ in the spec for a single request.
962
+ :type _request_auth: dict, optional
963
+ :type _content_type: string, optional: force content-type for the request
964
+ :return: Returns the result object.
965
+ If the method is called asynchronously,
966
+ returns the request thread.
967
+ :rtype: tuple(GroupReconciliationComparisonResult, status_code(int), headers(HTTPHeaderDict))
968
+ """
969
+
970
+ _params = locals()
971
+
972
+ _all_params = [
973
+ 'scope',
974
+ 'code',
975
+ 'result_id',
976
+ 'as_at'
977
+ ]
978
+ _all_params.extend(
979
+ [
980
+ 'async_req',
981
+ '_return_http_data_only',
982
+ '_preload_content',
983
+ '_request_timeout',
984
+ '_request_auth',
985
+ '_content_type',
986
+ '_headers',
987
+ 'opts'
988
+ ]
989
+ )
990
+
991
+ # validate the arguments
992
+ for _key, _val in _params['kwargs'].items():
993
+ if _key not in _all_params:
994
+ raise ApiTypeError(
995
+ "Got an unexpected keyword argument '%s'"
996
+ " to method get_comparison_result" % _key
997
+ )
998
+ _params[_key] = _val
999
+ del _params['kwargs']
1000
+
1001
+ _collection_formats = {}
1002
+
1003
+ # process the path parameters
1004
+ _path_params = {}
1005
+ if _params['scope']:
1006
+ _path_params['scope'] = _params['scope']
1007
+
1008
+ if _params['code']:
1009
+ _path_params['code'] = _params['code']
1010
+
1011
+ if _params['result_id']:
1012
+ _path_params['resultId'] = _params['result_id']
1013
+
1014
+
1015
+ # process the query parameters
1016
+ _query_params = []
1017
+ if _params.get('as_at') is not None: # noqa: E501
1018
+ if isinstance(_params['as_at'], datetime):
1019
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
1020
+ else:
1021
+ _query_params.append(('asAt', _params['as_at']))
1022
+
1023
+ # process the header parameters
1024
+ _header_params = dict(_params.get('_headers', {}))
1025
+ # process the form parameters
1026
+ _form_params = []
1027
+ _files = {}
1028
+ # process the body parameter
1029
+ _body_params = None
1030
+ # set the HTTP header `Accept`
1031
+ _header_params['Accept'] = self.api_client.select_header_accept(
1032
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1033
+
1034
+ # authentication setting
1035
+ _auth_settings = ['oauth2'] # noqa: E501
1036
+
1037
+ _response_types_map = {
1038
+ '200': "GroupReconciliationComparisonResult",
1039
+ '400': "LusidValidationProblemDetails",
1040
+ }
1041
+
1042
+ return self.api_client.call_api(
1043
+ '/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}/{resultId}', 'GET',
1044
+ _path_params,
1045
+ _query_params,
1046
+ _header_params,
1047
+ body=_body_params,
1048
+ post_params=_form_params,
1049
+ files=_files,
1050
+ response_types_map=_response_types_map,
1051
+ auth_settings=_auth_settings,
1052
+ async_req=_params.get('async_req'),
1053
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1054
+ _preload_content=_params.get('_preload_content', True),
1055
+ _request_timeout=_params.get('_request_timeout'),
1056
+ opts=_params.get('opts'),
1057
+ collection_formats=_collection_formats,
1058
+ _request_auth=_params.get('_request_auth'))
1059
+
1060
+ @overload
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
1062
+ ...
1063
+
1064
+ @overload
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
1066
+ ...
1067
+
1068
+ @validate_arguments
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
1071
+
1072
+ Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
1073
+ This method makes a synchronous HTTP request by default. To make an
1074
+ asynchronous HTTP request, please pass async_req=True
1075
+
1076
+ >>> thread = api.get_comparison_ruleset(scope, code, as_at, async_req=True)
1077
+ >>> result = thread.get()
1078
+
1079
+ :param scope: The scope of the specified comparison ruleset. (required)
1080
+ :type scope: str
1081
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
1082
+ :type code: str
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.
1084
+ :type as_at: datetime
1085
+ :param async_req: Whether to execute the request asynchronously.
1086
+ :type async_req: bool, optional
1087
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1088
+ :param opts: Configuration options for this request
1089
+ :type opts: ConfigurationOptions, optional
1090
+ :return: Returns the result object.
1091
+ If the method is called asynchronously,
1092
+ returns the request thread.
1093
+ :rtype: GroupReconciliationComparisonRuleset
1094
+ """
1095
+ kwargs['_return_http_data_only'] = True
1096
+ if '_preload_content' in kwargs:
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
1098
+ raise ValueError(message)
1099
+ if async_req is not None:
1100
+ kwargs['async_req'] = async_req
1101
+ return self.get_comparison_ruleset_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
1102
+
1103
+ @validate_arguments
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
1106
+
1107
+ Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
1108
+ This method makes a synchronous HTTP request by default. To make an
1109
+ asynchronous HTTP request, please pass async_req=True
1110
+
1111
+ >>> thread = api.get_comparison_ruleset_with_http_info(scope, code, as_at, async_req=True)
1112
+ >>> result = thread.get()
1113
+
1114
+ :param scope: The scope of the specified comparison ruleset. (required)
1115
+ :type scope: str
1116
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
1117
+ :type code: str
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.
1119
+ :type as_at: datetime
1120
+ :param async_req: Whether to execute the request asynchronously.
1121
+ :type async_req: bool, optional
1122
+ :param _preload_content: if False, the ApiResponse.data will
1123
+ be set to none and raw_data will store the
1124
+ HTTP response body without reading/decoding.
1125
+ Default is True.
1126
+ :type _preload_content: bool, optional
1127
+ :param _return_http_data_only: response data instead of ApiResponse
1128
+ object with status code, headers, etc
1129
+ :type _return_http_data_only: bool, optional
1130
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1131
+ :param opts: Configuration options for this request
1132
+ :type opts: ConfigurationOptions, optional
1133
+ :param _request_auth: set to override the auth_settings for an a single
1134
+ request; this effectively ignores the authentication
1135
+ in the spec for a single request.
1136
+ :type _request_auth: dict, optional
1137
+ :type _content_type: string, optional: force content-type for the request
1138
+ :return: Returns the result object.
1139
+ If the method is called asynchronously,
1140
+ returns the request thread.
1141
+ :rtype: tuple(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
1142
+ """
1143
+
1144
+ _params = locals()
1145
+
1146
+ _all_params = [
1147
+ 'scope',
1148
+ 'code',
1149
+ 'as_at'
1150
+ ]
1151
+ _all_params.extend(
1152
+ [
1153
+ 'async_req',
1154
+ '_return_http_data_only',
1155
+ '_preload_content',
1156
+ '_request_timeout',
1157
+ '_request_auth',
1158
+ '_content_type',
1159
+ '_headers',
1160
+ 'opts'
1161
+ ]
1162
+ )
1163
+
1164
+ # validate the arguments
1165
+ for _key, _val in _params['kwargs'].items():
1166
+ if _key not in _all_params:
1167
+ raise ApiTypeError(
1168
+ "Got an unexpected keyword argument '%s'"
1169
+ " to method get_comparison_ruleset" % _key
1170
+ )
1171
+ _params[_key] = _val
1172
+ del _params['kwargs']
1173
+
1174
+ _collection_formats = {}
1175
+
1176
+ # process the path parameters
1177
+ _path_params = {}
1178
+ if _params['scope']:
1179
+ _path_params['scope'] = _params['scope']
1180
+
1181
+ if _params['code']:
1182
+ _path_params['code'] = _params['code']
1183
+
1184
+
1185
+ # process the query parameters
1186
+ _query_params = []
1187
+ if _params.get('as_at') is not None: # noqa: E501
1188
+ if isinstance(_params['as_at'], datetime):
1189
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
1190
+ else:
1191
+ _query_params.append(('asAt', _params['as_at']))
1192
+
1193
+ # process the header parameters
1194
+ _header_params = dict(_params.get('_headers', {}))
1195
+ # process the form parameters
1196
+ _form_params = []
1197
+ _files = {}
1198
+ # process the body parameter
1199
+ _body_params = None
1200
+ # set the HTTP header `Accept`
1201
+ _header_params['Accept'] = self.api_client.select_header_accept(
1202
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1203
+
1204
+ # authentication setting
1205
+ _auth_settings = ['oauth2'] # noqa: E501
1206
+
1207
+ _response_types_map = {
1208
+ '200': "GroupReconciliationComparisonRuleset",
1209
+ '400': "LusidValidationProblemDetails",
1210
+ }
1211
+
1212
+ return self.api_client.call_api(
1213
+ '/api/reconciliations/comparisonrulesets/{scope}/{code}', 'GET',
1214
+ _path_params,
1215
+ _query_params,
1216
+ _header_params,
1217
+ body=_body_params,
1218
+ post_params=_form_params,
1219
+ files=_files,
1220
+ response_types_map=_response_types_map,
1221
+ auth_settings=_auth_settings,
1222
+ async_req=_params.get('async_req'),
1223
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1224
+ _preload_content=_params.get('_preload_content', True),
1225
+ _request_timeout=_params.get('_request_timeout'),
1226
+ opts=_params.get('opts'),
1227
+ collection_formats=_collection_formats,
1228
+ _request_auth=_params.get('_request_auth'))
1229
+
1230
+ @overload
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
1232
+ ...
1233
+
1234
+ @overload
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
1236
+ ...
1237
+
1238
+ @validate_arguments
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
1241
+
1242
+ Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
1243
+ This method makes a synchronous HTTP request by default. To make an
1244
+ asynchronous HTTP request, please pass async_req=True
1245
+
1246
+ >>> thread = api.get_group_reconciliation_definition(scope, code, effective_at, as_at, async_req=True)
1247
+ >>> result = thread.get()
1248
+
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.
1256
+ :type as_at: datetime
1257
+ :param async_req: Whether to execute the request asynchronously.
1258
+ :type async_req: bool, optional
1259
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1260
+ :param opts: Configuration options for this request
1261
+ :type opts: ConfigurationOptions, optional
1262
+ :return: Returns the result object.
1263
+ If the method is called asynchronously,
1264
+ returns the request thread.
1265
+ :rtype: GroupReconciliationDefinition
1266
+ """
1267
+ kwargs['_return_http_data_only'] = True
1268
+ if '_preload_content' in kwargs:
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
1270
+ raise ValueError(message)
1271
+ if async_req is not None:
1272
+ kwargs['async_req'] = async_req
1273
+ return self.get_group_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, **kwargs) # noqa: E501
1274
+
1275
+ @validate_arguments
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
1278
+
1279
+ Retrieves a Group Reconciliation Definition by scope and code # noqa: E501
1280
+ This method makes a synchronous HTTP request by default. To make an
1281
+ asynchronous HTTP request, please pass async_req=True
1282
+
1283
+ >>> thread = api.get_group_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, async_req=True)
1284
+ >>> result = thread.get()
1285
+
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.
1656
+ :type page: str
1657
+ :param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
1658
+ :type sort_by: List[str]
1659
+ :param limit: When paginating, limit the number of returned results to this many per page.
1660
+ :type limit: int
1661
+ :param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
1662
+ :type filter: str
1663
+ :param async_req: Whether to execute the request asynchronously.
1664
+ :type async_req: bool, optional
1665
+ :param _preload_content: if False, the ApiResponse.data will
1666
+ be set to none and raw_data will store the
1667
+ HTTP response body without reading/decoding.
1668
+ Default is True.
1669
+ :type _preload_content: bool, optional
1670
+ :param _return_http_data_only: response data instead of ApiResponse
1671
+ object with status code, headers, etc
1672
+ :type _return_http_data_only: bool, optional
1673
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1674
+ :param opts: Configuration options for this request
1675
+ :type opts: ConfigurationOptions, optional
1676
+ :param _request_auth: set to override the auth_settings for an a single
1677
+ request; this effectively ignores the authentication
1678
+ in the spec for a single request.
1679
+ :type _request_auth: dict, optional
1680
+ :type _content_type: string, optional: force content-type for the request
1681
+ :return: Returns the result object.
1682
+ If the method is called asynchronously,
1683
+ returns the request thread.
1684
+ :rtype: tuple(PagedResourceListOfGroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
1685
+ """
1686
+
1687
+ _params = locals()
1688
+
1689
+ _all_params = [
1690
+ 'as_at',
1691
+ 'page',
1692
+ 'sort_by',
1693
+ 'limit',
1694
+ 'filter'
1695
+ ]
1696
+ _all_params.extend(
1697
+ [
1698
+ 'async_req',
1699
+ '_return_http_data_only',
1700
+ '_preload_content',
1701
+ '_request_timeout',
1702
+ '_request_auth',
1703
+ '_content_type',
1704
+ '_headers',
1705
+ 'opts'
1706
+ ]
1707
+ )
1708
+
1709
+ # validate the arguments
1710
+ for _key, _val in _params['kwargs'].items():
1711
+ if _key not in _all_params:
1712
+ raise ApiTypeError(
1713
+ "Got an unexpected keyword argument '%s'"
1714
+ " to method list_comparison_rulesets" % _key
1715
+ )
1716
+ _params[_key] = _val
1717
+ del _params['kwargs']
1718
+
1719
+ _collection_formats = {}
1720
+
1721
+ # process the path parameters
1722
+ _path_params = {}
1723
+
1724
+ # process the query parameters
1725
+ _query_params = []
1726
+ if _params.get('as_at') is not None: # noqa: E501
1727
+ if isinstance(_params['as_at'], datetime):
1728
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
1729
+ else:
1730
+ _query_params.append(('asAt', _params['as_at']))
1731
+
1732
+ if _params.get('page') is not None: # noqa: E501
1733
+ _query_params.append(('page', _params['page']))
1734
+
1735
+ if _params.get('sort_by') is not None: # noqa: E501
1736
+ _query_params.append(('sortBy', _params['sort_by']))
1737
+ _collection_formats['sortBy'] = 'multi'
1738
+
1739
+ if _params.get('limit') is not None: # noqa: E501
1740
+ _query_params.append(('limit', _params['limit']))
1741
+
1742
+ if _params.get('filter') is not None: # noqa: E501
1743
+ _query_params.append(('filter', _params['filter']))
1744
+
1745
+ # process the header parameters
1746
+ _header_params = dict(_params.get('_headers', {}))
1747
+ # process the form parameters
1748
+ _form_params = []
1749
+ _files = {}
1750
+ # process the body parameter
1751
+ _body_params = None
1752
+ # set the HTTP header `Accept`
1753
+ _header_params['Accept'] = self.api_client.select_header_accept(
1754
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1755
+
1756
+ # authentication setting
1757
+ _auth_settings = ['oauth2'] # noqa: E501
1758
+
1759
+ _response_types_map = {
1760
+ '200': "PagedResourceListOfGroupReconciliationComparisonRuleset",
1761
+ '400': "LusidValidationProblemDetails",
1762
+ }
1763
+
1764
+ return self.api_client.call_api(
1765
+ '/api/reconciliations/comparisonrulesets', 'GET',
1766
+ _path_params,
1767
+ _query_params,
1768
+ _header_params,
1769
+ body=_body_params,
1770
+ post_params=_form_params,
1771
+ files=_files,
1772
+ response_types_map=_response_types_map,
1773
+ auth_settings=_auth_settings,
1774
+ async_req=_params.get('async_req'),
1775
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1776
+ _preload_content=_params.get('_preload_content', True),
1777
+ _request_timeout=_params.get('_request_timeout'),
1778
+ opts=_params.get('opts'),
1779
+ collection_formats=_collection_formats,
1780
+ _request_auth=_params.get('_request_auth'))
1781
+
1782
+ @overload
1783
+ async def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition 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 group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> PagedResourceListOfGroupReconciliationDefinition: # noqa: E501
1784
+ ...
1785
+
1786
+ @overload
1787
+ def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition 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 group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfGroupReconciliationDefinition: # noqa: E501
1788
+ ...
1789
+
1790
+ @validate_arguments
1791
+ def list_group_reconciliation_definitions(self, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition 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 group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfGroupReconciliationDefinition, Awaitable[PagedResourceListOfGroupReconciliationDefinition]]: # noqa: E501
1792
+ """[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
1793
+
1794
+ Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # noqa: E501
1795
+ This method makes a synchronous HTTP request by default. To make an
1796
+ asynchronous HTTP request, please pass async_req=True
1797
+
1798
+ >>> thread = api.list_group_reconciliation_definitions(effective_at, as_at, page, limit, filter, sort_by, async_req=True)
1799
+ >>> result = thread.get()
1800
+
1801
+ :param effective_at: The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.
1802
+ :type effective_at: str
1803
+ :param as_at: The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
1804
+ :type as_at: datetime
1805
+ :param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
1806
+ :type page: str
1807
+ :param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
1808
+ :type limit: int
1809
+ :param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
1810
+ :type filter: str
1811
+ :param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
1812
+ :type sort_by: List[str]
1813
+ :param async_req: Whether to execute the request asynchronously.
1814
+ :type async_req: bool, optional
1815
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1816
+ :param opts: Configuration options for this request
1817
+ :type opts: ConfigurationOptions, optional
1818
+ :return: Returns the result object.
1819
+ If the method is called asynchronously,
1820
+ returns the request thread.
1821
+ :rtype: PagedResourceListOfGroupReconciliationDefinition
1822
+ """
1823
+ kwargs['_return_http_data_only'] = True
1824
+ if '_preload_content' in kwargs:
1825
+ message = "Error! Please call the list_group_reconciliation_definitions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
1826
+ raise ValueError(message)
1827
+ if async_req is not None:
1828
+ kwargs['async_req'] = async_req
1829
+ return self.list_group_reconciliation_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
1830
+
1831
+ @validate_arguments
1832
+ def list_group_reconciliation_definitions_with_http_info(self, effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition 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 group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
1833
+ """[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
1834
+
1835
+ Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # noqa: E501
1836
+ This method makes a synchronous HTTP request by default. To make an
1837
+ asynchronous HTTP request, please pass async_req=True
1838
+
1839
+ >>> thread = api.list_group_reconciliation_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, async_req=True)
1840
+ >>> result = thread.get()
1841
+
1842
+ :param effective_at: The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.
1843
+ :type effective_at: str
1844
+ :param as_at: The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
1845
+ :type as_at: datetime
1846
+ :param page: The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request.
1847
+ :type page: str
1848
+ :param limit: When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.
1849
+ :type limit: int
1850
+ :param filter: Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
1851
+ :type filter: str
1852
+ :param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
1853
+ :type sort_by: List[str]
1854
+ :param async_req: Whether to execute the request asynchronously.
1855
+ :type async_req: bool, optional
1856
+ :param _preload_content: if False, the ApiResponse.data will
1857
+ be set to none and raw_data will store the
1858
+ HTTP response body without reading/decoding.
1859
+ Default is True.
1860
+ :type _preload_content: bool, optional
1861
+ :param _return_http_data_only: response data instead of ApiResponse
1862
+ object with status code, headers, etc
1863
+ :type _return_http_data_only: bool, optional
1864
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1865
+ :param opts: Configuration options for this request
1866
+ :type opts: ConfigurationOptions, optional
1867
+ :param _request_auth: set to override the auth_settings for an a single
1868
+ request; this effectively ignores the authentication
1869
+ in the spec for a single request.
1870
+ :type _request_auth: dict, optional
1871
+ :type _content_type: string, optional: force content-type for the request
1872
+ :return: Returns the result object.
1873
+ If the method is called asynchronously,
1874
+ returns the request thread.
1875
+ :rtype: tuple(PagedResourceListOfGroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
1876
+ """
1877
+
1878
+ _params = locals()
1879
+
1880
+ _all_params = [
1881
+ 'effective_at',
1882
+ 'as_at',
1883
+ 'page',
1884
+ 'limit',
1885
+ 'filter',
1886
+ 'sort_by'
1887
+ ]
1888
+ _all_params.extend(
1889
+ [
1890
+ 'async_req',
1891
+ '_return_http_data_only',
1892
+ '_preload_content',
1893
+ '_request_timeout',
1894
+ '_request_auth',
1895
+ '_content_type',
1896
+ '_headers',
1897
+ 'opts'
1898
+ ]
1899
+ )
1900
+
1901
+ # validate the arguments
1902
+ for _key, _val in _params['kwargs'].items():
1903
+ if _key not in _all_params:
1904
+ raise ApiTypeError(
1905
+ "Got an unexpected keyword argument '%s'"
1906
+ " to method list_group_reconciliation_definitions" % _key
1907
+ )
1908
+ _params[_key] = _val
1909
+ del _params['kwargs']
1910
+
1911
+ _collection_formats = {}
1912
+
1913
+ # process the path parameters
1914
+ _path_params = {}
1915
+
1916
+ # process the query parameters
1917
+ _query_params = []
1918
+ if _params.get('effective_at') is not None: # noqa: E501
1919
+ _query_params.append(('effectiveAt', _params['effective_at']))
1920
+
1921
+ if _params.get('as_at') is not None: # noqa: E501
1922
+ if isinstance(_params['as_at'], datetime):
1923
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
1924
+ else:
1925
+ _query_params.append(('asAt', _params['as_at']))
1926
+
1927
+ if _params.get('page') is not None: # noqa: E501
1928
+ _query_params.append(('page', _params['page']))
1929
+
1930
+ if _params.get('limit') is not None: # noqa: E501
1931
+ _query_params.append(('limit', _params['limit']))
1932
+
1933
+ if _params.get('filter') is not None: # noqa: E501
1934
+ _query_params.append(('filter', _params['filter']))
1935
+
1936
+ if _params.get('sort_by') is not None: # noqa: E501
1937
+ _query_params.append(('sortBy', _params['sort_by']))
1938
+ _collection_formats['sortBy'] = 'multi'
1939
+
1940
+ # process the header parameters
1941
+ _header_params = dict(_params.get('_headers', {}))
1942
+ # process the form parameters
1943
+ _form_params = []
1944
+ _files = {}
1945
+ # process the body parameter
1946
+ _body_params = None
1947
+ # set the HTTP header `Accept`
1948
+ _header_params['Accept'] = self.api_client.select_header_accept(
1949
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1950
+
1951
+ # authentication setting
1952
+ _auth_settings = ['oauth2'] # noqa: E501
1953
+
1954
+ _response_types_map = {
1955
+ '200': "PagedResourceListOfGroupReconciliationDefinition",
1956
+ '400': "LusidValidationProblemDetails",
1957
+ }
1958
+
1959
+ return self.api_client.call_api(
1960
+ '/api/reconciliations/groupreconciliationdefinitions', 'GET',
1961
+ _path_params,
1962
+ _query_params,
1963
+ _header_params,
1964
+ body=_body_params,
1965
+ post_params=_form_params,
1966
+ files=_files,
1967
+ response_types_map=_response_types_map,
1968
+ auth_settings=_auth_settings,
1969
+ async_req=_params.get('async_req'),
1970
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1971
+ _preload_content=_params.get('_preload_content', True),
1972
+ _request_timeout=_params.get('_request_timeout'),
1973
+ opts=_params.get('opts'),
1974
+ collection_formats=_collection_formats,
1975
+ _request_auth=_params.get('_request_auth'))
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
+
2151
+ @overload
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
2153
+ ...
2154
+
2155
+ @overload
2156
+ 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, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationComparisonRuleset: # noqa: E501
2157
+ ...
2158
+
2159
+ @validate_arguments
2160
+ 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, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationComparisonRuleset, Awaitable[GroupReconciliationComparisonRuleset]]: # noqa: E501
2161
+ """[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
2162
+
2163
+ Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # noqa: E501
2164
+ This method makes a synchronous HTTP request by default. To make an
2165
+ asynchronous HTTP request, please pass async_req=True
2166
+
2167
+ >>> thread = api.update_comparison_ruleset(scope, code, update_group_reconciliation_comparison_ruleset_request, async_req=True)
2168
+ >>> result = thread.get()
2169
+
2170
+ :param scope: The scope of the specified comparison ruleset. (required)
2171
+ :type scope: str
2172
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
2173
+ :type code: str
2174
+ :param update_group_reconciliation_comparison_ruleset_request: The request containing the updated details of the ruleset
2175
+ :type update_group_reconciliation_comparison_ruleset_request: UpdateGroupReconciliationComparisonRulesetRequest
2176
+ :param async_req: Whether to execute the request asynchronously.
2177
+ :type async_req: bool, optional
2178
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
2179
+ :param opts: Configuration options for this request
2180
+ :type opts: ConfigurationOptions, optional
2181
+ :return: Returns the result object.
2182
+ If the method is called asynchronously,
2183
+ returns the request thread.
2184
+ :rtype: GroupReconciliationComparisonRuleset
2185
+ """
2186
+ kwargs['_return_http_data_only'] = True
2187
+ if '_preload_content' in kwargs:
2188
+ message = "Error! Please call the update_comparison_ruleset_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
2189
+ raise ValueError(message)
2190
+ if async_req is not None:
2191
+ kwargs['async_req'] = async_req
2192
+ return self.update_comparison_ruleset_with_http_info(scope, code, update_group_reconciliation_comparison_ruleset_request, **kwargs) # noqa: E501
2193
+
2194
+ @validate_arguments
2195
+ def update_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.")], update_group_reconciliation_comparison_ruleset_request : Annotated[Optional[UpdateGroupReconciliationComparisonRulesetRequest], Field(description="The request containing the updated details of the ruleset")] = None, **kwargs) -> ApiResponse: # noqa: E501
2196
+ """[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
2197
+
2198
+ Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # noqa: E501
2199
+ This method makes a synchronous HTTP request by default. To make an
2200
+ asynchronous HTTP request, please pass async_req=True
2201
+
2202
+ >>> thread = api.update_comparison_ruleset_with_http_info(scope, code, update_group_reconciliation_comparison_ruleset_request, async_req=True)
2203
+ >>> result = thread.get()
2204
+
2205
+ :param scope: The scope of the specified comparison ruleset. (required)
2206
+ :type scope: str
2207
+ :param code: The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
2208
+ :type code: str
2209
+ :param update_group_reconciliation_comparison_ruleset_request: The request containing the updated details of the ruleset
2210
+ :type update_group_reconciliation_comparison_ruleset_request: UpdateGroupReconciliationComparisonRulesetRequest
2211
+ :param async_req: Whether to execute the request asynchronously.
2212
+ :type async_req: bool, optional
2213
+ :param _preload_content: if False, the ApiResponse.data will
2214
+ be set to none and raw_data will store the
2215
+ HTTP response body without reading/decoding.
2216
+ Default is True.
2217
+ :type _preload_content: bool, optional
2218
+ :param _return_http_data_only: response data instead of ApiResponse
2219
+ object with status code, headers, etc
2220
+ :type _return_http_data_only: bool, optional
2221
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
2222
+ :param opts: Configuration options for this request
2223
+ :type opts: ConfigurationOptions, optional
2224
+ :param _request_auth: set to override the auth_settings for an a single
2225
+ request; this effectively ignores the authentication
2226
+ in the spec for a single request.
2227
+ :type _request_auth: dict, optional
2228
+ :type _content_type: string, optional: force content-type for the request
2229
+ :return: Returns the result object.
2230
+ If the method is called asynchronously,
2231
+ returns the request thread.
2232
+ :rtype: tuple(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
2233
+ """
2234
+
2235
+ _params = locals()
2236
+
2237
+ _all_params = [
2238
+ 'scope',
2239
+ 'code',
2240
+ 'update_group_reconciliation_comparison_ruleset_request'
2241
+ ]
2242
+ _all_params.extend(
2243
+ [
2244
+ 'async_req',
2245
+ '_return_http_data_only',
2246
+ '_preload_content',
2247
+ '_request_timeout',
2248
+ '_request_auth',
2249
+ '_content_type',
2250
+ '_headers',
2251
+ 'opts'
2252
+ ]
2253
+ )
2254
+
2255
+ # validate the arguments
2256
+ for _key, _val in _params['kwargs'].items():
2257
+ if _key not in _all_params:
2258
+ raise ApiTypeError(
2259
+ "Got an unexpected keyword argument '%s'"
2260
+ " to method update_comparison_ruleset" % _key
2261
+ )
2262
+ _params[_key] = _val
2263
+ del _params['kwargs']
2264
+
2265
+ _collection_formats = {}
2266
+
2267
+ # process the path parameters
2268
+ _path_params = {}
2269
+ if _params['scope']:
2270
+ _path_params['scope'] = _params['scope']
2271
+
2272
+ if _params['code']:
2273
+ _path_params['code'] = _params['code']
2274
+
2275
+
2276
+ # process the query parameters
2277
+ _query_params = []
2278
+ # process the header parameters
2279
+ _header_params = dict(_params.get('_headers', {}))
2280
+ # process the form parameters
2281
+ _form_params = []
2282
+ _files = {}
2283
+ # process the body parameter
2284
+ _body_params = None
2285
+ if _params['update_group_reconciliation_comparison_ruleset_request'] is not None:
2286
+ _body_params = _params['update_group_reconciliation_comparison_ruleset_request']
2287
+
2288
+ # set the HTTP header `Accept`
2289
+ _header_params['Accept'] = self.api_client.select_header_accept(
2290
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
2291
+
2292
+ # set the HTTP header `Content-Type`
2293
+ _content_types_list = _params.get('_content_type',
2294
+ self.api_client.select_header_content_type(
2295
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
2296
+ if _content_types_list:
2297
+ _header_params['Content-Type'] = _content_types_list
2298
+
2299
+ # authentication setting
2300
+ _auth_settings = ['oauth2'] # noqa: E501
2301
+
2302
+ _response_types_map = {
2303
+ '200': "GroupReconciliationComparisonRuleset",
2304
+ '400': "LusidValidationProblemDetails",
2305
+ }
2306
+
2307
+ return self.api_client.call_api(
2308
+ '/api/reconciliations/comparisonrulesets/{scope}/{code}', 'PUT',
2309
+ _path_params,
2310
+ _query_params,
2311
+ _header_params,
2312
+ body=_body_params,
2313
+ post_params=_form_params,
2314
+ files=_files,
2315
+ response_types_map=_response_types_map,
2316
+ auth_settings=_auth_settings,
2317
+ async_req=_params.get('async_req'),
2318
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
2319
+ _preload_content=_params.get('_preload_content', True),
2320
+ _request_timeout=_params.get('_request_timeout'),
2321
+ opts=_params.get('opts'),
2322
+ collection_formats=_collection_formats,
2323
+ _request_auth=_params.get('_request_auth'))
2324
+
2325
+ @overload
2326
+ async def update_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 update the details for.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.")], update_group_reconciliation_definition_request : Annotated[Optional[UpdateGroupReconciliationDefinitionRequest], Field(description="The updated group reconciliation definition.")] = None, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
2327
+ ...
2328
+
2329
+ @overload
2330
+ def update_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 update the details for.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.")], update_group_reconciliation_definition_request : Annotated[Optional[UpdateGroupReconciliationDefinitionRequest], Field(description="The updated group reconciliation definition.")] = None, async_req: Optional[bool]=True, **kwargs) -> GroupReconciliationDefinition: # noqa: E501
2331
+ ...
2332
+
2333
+ @validate_arguments
2334
+ def update_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 update the details for.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.")], update_group_reconciliation_definition_request : Annotated[Optional[UpdateGroupReconciliationDefinitionRequest], Field(description="The updated group reconciliation definition.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GroupReconciliationDefinition, Awaitable[GroupReconciliationDefinition]]: # noqa: E501
2335
+ """[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
2336
+
2337
+ Update the group reconciliation definition. # noqa: E501
2338
+ This method makes a synchronous HTTP request by default. To make an
2339
+ asynchronous HTTP request, please pass async_req=True
2340
+
2341
+ >>> thread = api.update_group_reconciliation_definition(scope, code, update_group_reconciliation_definition_request, async_req=True)
2342
+ >>> result = thread.get()
2343
+
2344
+ :param scope: The scope of the group reconciliation definition to update the details for. (required)
2345
+ :type scope: str
2346
+ :param code: The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition. (required)
2347
+ :type code: str
2348
+ :param update_group_reconciliation_definition_request: The updated group reconciliation definition.
2349
+ :type update_group_reconciliation_definition_request: UpdateGroupReconciliationDefinitionRequest
2350
+ :param async_req: Whether to execute the request asynchronously.
2351
+ :type async_req: bool, optional
2352
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
2353
+ :param opts: Configuration options for this request
2354
+ :type opts: ConfigurationOptions, optional
2355
+ :return: Returns the result object.
2356
+ If the method is called asynchronously,
2357
+ returns the request thread.
2358
+ :rtype: GroupReconciliationDefinition
2359
+ """
2360
+ kwargs['_return_http_data_only'] = True
2361
+ if '_preload_content' in kwargs:
2362
+ message = "Error! Please call the update_group_reconciliation_definition_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
2363
+ raise ValueError(message)
2364
+ if async_req is not None:
2365
+ kwargs['async_req'] = async_req
2366
+ return self.update_group_reconciliation_definition_with_http_info(scope, code, update_group_reconciliation_definition_request, **kwargs) # noqa: E501
2367
+
2368
+ @validate_arguments
2369
+ def update_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 update the details for.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition.")], update_group_reconciliation_definition_request : Annotated[Optional[UpdateGroupReconciliationDefinitionRequest], Field(description="The updated group reconciliation definition.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2370
+ """[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
2371
+
2372
+ Update the group reconciliation definition. # noqa: E501
2373
+ This method makes a synchronous HTTP request by default. To make an
2374
+ asynchronous HTTP request, please pass async_req=True
2375
+
2376
+ >>> thread = api.update_group_reconciliation_definition_with_http_info(scope, code, update_group_reconciliation_definition_request, async_req=True)
2377
+ >>> result = thread.get()
2378
+
2379
+ :param scope: The scope of the group reconciliation definition to update the details for. (required)
2380
+ :type scope: str
2381
+ :param code: The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition. (required)
2382
+ :type code: str
2383
+ :param update_group_reconciliation_definition_request: The updated group reconciliation definition.
2384
+ :type update_group_reconciliation_definition_request: UpdateGroupReconciliationDefinitionRequest
2385
+ :param async_req: Whether to execute the request asynchronously.
2386
+ :type async_req: bool, optional
2387
+ :param _preload_content: if False, the ApiResponse.data will
2388
+ be set to none and raw_data will store the
2389
+ HTTP response body without reading/decoding.
2390
+ Default is True.
2391
+ :type _preload_content: bool, optional
2392
+ :param _return_http_data_only: response data instead of ApiResponse
2393
+ object with status code, headers, etc
2394
+ :type _return_http_data_only: bool, optional
2395
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
2396
+ :param opts: Configuration options for this request
2397
+ :type opts: ConfigurationOptions, optional
2398
+ :param _request_auth: set to override the auth_settings for an a single
2399
+ request; this effectively ignores the authentication
2400
+ in the spec for a single request.
2401
+ :type _request_auth: dict, optional
2402
+ :type _content_type: string, optional: force content-type for the request
2403
+ :return: Returns the result object.
2404
+ If the method is called asynchronously,
2405
+ returns the request thread.
2406
+ :rtype: tuple(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
2407
+ """
2408
+
2409
+ _params = locals()
2410
+
2411
+ _all_params = [
2412
+ 'scope',
2413
+ 'code',
2414
+ 'update_group_reconciliation_definition_request'
2415
+ ]
2416
+ _all_params.extend(
2417
+ [
2418
+ 'async_req',
2419
+ '_return_http_data_only',
2420
+ '_preload_content',
2421
+ '_request_timeout',
2422
+ '_request_auth',
2423
+ '_content_type',
2424
+ '_headers',
2425
+ 'opts'
2426
+ ]
2427
+ )
2428
+
2429
+ # validate the arguments
2430
+ for _key, _val in _params['kwargs'].items():
2431
+ if _key not in _all_params:
2432
+ raise ApiTypeError(
2433
+ "Got an unexpected keyword argument '%s'"
2434
+ " to method update_group_reconciliation_definition" % _key
2435
+ )
2436
+ _params[_key] = _val
2437
+ del _params['kwargs']
2438
+
2439
+ _collection_formats = {}
2440
+
2441
+ # process the path parameters
2442
+ _path_params = {}
2443
+ if _params['scope']:
2444
+ _path_params['scope'] = _params['scope']
2445
+
2446
+ if _params['code']:
2447
+ _path_params['code'] = _params['code']
2448
+
2449
+
2450
+ # process the query parameters
2451
+ _query_params = []
2452
+ # process the header parameters
2453
+ _header_params = dict(_params.get('_headers', {}))
2454
+ # process the form parameters
2455
+ _form_params = []
2456
+ _files = {}
2457
+ # process the body parameter
2458
+ _body_params = None
2459
+ if _params['update_group_reconciliation_definition_request'] is not None:
2460
+ _body_params = _params['update_group_reconciliation_definition_request']
2461
+
2462
+ # set the HTTP header `Accept`
2463
+ _header_params['Accept'] = self.api_client.select_header_accept(
2464
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
2465
+
2466
+ # set the HTTP header `Content-Type`
2467
+ _content_types_list = _params.get('_content_type',
2468
+ self.api_client.select_header_content_type(
2469
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
2470
+ if _content_types_list:
2471
+ _header_params['Content-Type'] = _content_types_list
2472
+
2473
+ # authentication setting
2474
+ _auth_settings = ['oauth2'] # noqa: E501
2475
+
2476
+ _response_types_map = {
2477
+ '200': "GroupReconciliationDefinition",
2478
+ '400': "LusidValidationProblemDetails",
2479
+ }
2480
+
2481
+ return self.api_client.call_api(
2482
+ '/api/reconciliations/groupreconciliationdefinitions/{scope}/{code}', 'PUT',
365
2483
  _path_params,
366
2484
  _query_params,
367
2485
  _header_params,
@@ -374,5 +2492,6 @@ class GroupReconciliationsApi:
374
2492
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
375
2493
  _preload_content=_params.get('_preload_content', True),
376
2494
  _request_timeout=_params.get('_request_timeout'),
2495
+ opts=_params.get('opts'),
377
2496
  collection_formats=_collection_formats,
378
2497
  _request_auth=_params.get('_request_auth'))