lusid-sdk 2.0.50b0__py3-none-any.whl → 2.0.430__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.

Potentially problematic release.


This version of lusid-sdk might be problematic. Click here for more details.

Files changed (317) hide show
  1. lusid/__init__.py +92 -13
  2. lusid/api/__init__.py +2 -0
  3. lusid/api/abor_api.py +513 -179
  4. lusid/api/abor_configuration_api.py +25 -24
  5. lusid/api/allocations_api.py +12 -20
  6. lusid/api/blocks_api.py +6 -6
  7. lusid/api/calendars_api.py +16 -24
  8. lusid/api/chart_of_accounts_api.py +1745 -441
  9. lusid/api/compliance_api.py +71 -62
  10. lusid/api/configuration_recipe_api.py +1198 -56
  11. lusid/api/corporate_action_sources_api.py +8 -8
  12. lusid/api/custom_entities_api.py +6 -6
  13. lusid/api/cut_label_definitions_api.py +9 -17
  14. lusid/api/data_types_api.py +16 -32
  15. lusid/api/executions_api.py +6 -6
  16. lusid/api/funds_api.py +944 -0
  17. lusid/api/instrument_event_types_api.py +1287 -0
  18. lusid/api/instruments_api.py +12 -20
  19. lusid/api/legacy_compliance_api.py +12 -12
  20. lusid/api/legal_entities_api.py +12 -12
  21. lusid/api/order_graph_api.py +12 -12
  22. lusid/api/order_instructions_api.py +6 -6
  23. lusid/api/order_management_api.py +495 -14
  24. lusid/api/orders_api.py +16 -24
  25. lusid/api/packages_api.py +6 -6
  26. lusid/api/persons_api.py +16 -24
  27. lusid/api/placements_api.py +12 -12
  28. lusid/api/portfolio_groups_api.py +6 -6
  29. lusid/api/portfolios_api.py +23 -39
  30. lusid/api/property_definitions_api.py +205 -0
  31. lusid/api/quotes_api.py +20 -36
  32. lusid/api/reconciliations_api.py +410 -1978
  33. lusid/api/schemas_api.py +7 -15
  34. lusid/api/scopes_api.py +151 -0
  35. lusid/api/scripted_translation_api.py +30 -28
  36. lusid/api/transaction_configuration_api.py +22 -22
  37. lusid/api/transaction_portfolios_api.py +282 -577
  38. lusid/api_client.py +5 -3
  39. lusid/configuration.py +1 -1
  40. lusid/extensions/__init__.py +1 -9
  41. lusid/extensions/api_client.py +3 -1
  42. lusid/extensions/api_client_factory.py +156 -45
  43. lusid/extensions/api_configuration.py +124 -15
  44. lusid/extensions/configuration_loaders.py +2 -4
  45. lusid/extensions/proxy_config.py +8 -5
  46. lusid/extensions/socket_keep_alive.py +14 -15
  47. lusid/extensions/tcp_keep_alive_connector.py +93 -46
  48. lusid/models/__init__.py +90 -13
  49. lusid/models/abor.py +9 -2
  50. lusid/models/abor_configuration.py +8 -8
  51. lusid/models/abor_configuration_request.py +9 -9
  52. lusid/models/abor_request.py +1 -1
  53. lusid/models/account.py +6 -1
  54. lusid/models/accumulation_event.py +104 -0
  55. lusid/models/address_key_compliance_parameter.py +5 -12
  56. lusid/models/address_key_list_compliance_parameter.py +3 -3
  57. lusid/models/address_key_option_definition.py +3 -1
  58. lusid/models/amortisation_event.py +4 -6
  59. lusid/models/{underlying_leg.py → asset_leg.py} +15 -15
  60. lusid/models/basket.py +3 -3
  61. lusid/models/block_and_order_id_request.py +78 -0
  62. lusid/models/block_and_orders.py +83 -0
  63. lusid/models/block_and_orders_create_request.py +77 -0
  64. lusid/models/block_and_orders_request.py +134 -0
  65. lusid/models/blocked_order_request.py +130 -0
  66. lusid/models/bond.py +13 -6
  67. lusid/models/bond_coupon_event.py +97 -0
  68. lusid/models/bond_default_event.py +8 -18
  69. lusid/models/bond_principal_event.py +97 -0
  70. lusid/models/book_transactions_request.py +97 -0
  71. lusid/models/bool_compliance_parameter.py +3 -3
  72. lusid/models/bool_list_compliance_parameter.py +3 -3
  73. lusid/models/branch_step.py +101 -0
  74. lusid/models/cap_floor.py +3 -3
  75. lusid/models/cash_dividend_event.py +32 -10
  76. lusid/models/cash_election.py +91 -0
  77. lusid/models/cash_flow_event.py +5 -7
  78. lusid/models/cash_perpetual.py +3 -3
  79. lusid/models/cds_flow_conventions.py +1 -1
  80. lusid/models/cds_index.py +4 -4
  81. lusid/models/check_step.py +110 -0
  82. lusid/models/cleardown_module_details.py +95 -0
  83. lusid/models/cleardown_module_request.py +117 -0
  84. lusid/models/cleardown_module_response.py +139 -0
  85. lusid/models/cleardown_module_rule.py +94 -0
  86. lusid/models/{reconciliation_run_break.py → cleardown_module_rules_updated_response.py} +30 -36
  87. lusid/models/close_event.py +3 -3
  88. lusid/models/close_period_diary_entry_request.py +149 -0
  89. lusid/models/complete_portfolio.py +8 -1
  90. lusid/models/complex_bond.py +4 -4
  91. lusid/models/complex_market_data.py +6 -5
  92. lusid/models/compliance_parameter.py +8 -5
  93. lusid/models/compliance_parameter_type.py +3 -0
  94. lusid/models/compliance_rule_breakdown.py +16 -8
  95. lusid/models/compliance_rule_breakdown_request.py +12 -4
  96. lusid/models/compliance_rule_result_v2.py +85 -0
  97. lusid/models/compliance_step.py +99 -0
  98. lusid/models/compliance_step_type.py +42 -0
  99. lusid/models/compliance_summary_rule_result.py +12 -15
  100. lusid/models/compliance_summary_rule_result_request.py +12 -15
  101. lusid/models/compliance_template_variation.py +12 -2
  102. lusid/models/component_transaction.py +92 -0
  103. lusid/models/composite_dispersion.py +30 -5
  104. lusid/models/compounding.py +4 -4
  105. lusid/models/configuration_recipe.py +10 -19
  106. lusid/models/constant_volatility_surface.py +102 -0
  107. lusid/models/contract_for_difference.py +3 -3
  108. lusid/models/create_derived_property_definition_request.py +3 -3
  109. lusid/models/create_derived_transaction_portfolio_request.py +10 -3
  110. lusid/models/create_property_definition_request.py +12 -5
  111. lusid/models/create_trade_tickets_response.py +87 -0
  112. lusid/models/create_transaction_portfolio_request.py +16 -3
  113. lusid/models/credit_default_swap.py +4 -4
  114. lusid/models/credit_spread_curve_data.py +4 -4
  115. lusid/models/custom_entity_definition.py +8 -2
  116. lusid/models/custom_entity_type.py +8 -2
  117. lusid/models/cut_label_definition.py +7 -1
  118. lusid/models/data_type.py +7 -1
  119. lusid/models/data_type_summary.py +8 -2
  120. lusid/models/date_time_compliance_parameter.py +3 -3
  121. lusid/models/date_time_list_compliance_parameter.py +3 -3
  122. lusid/models/{upsert_reconciliation_run_request.py → day_month.py} +15 -15
  123. lusid/models/decimal_compliance_parameter.py +3 -3
  124. lusid/models/decimal_list_compliance_parameter.py +3 -3
  125. lusid/models/dialect.py +9 -3
  126. lusid/models/diary_entry.py +1 -1
  127. lusid/models/diary_entry_request.py +1 -1
  128. lusid/models/discount_factor_curve_data.py +3 -3
  129. lusid/models/dividend_option_event.py +129 -0
  130. lusid/models/dividend_reinvestment_event.py +122 -0
  131. lusid/models/election_specification.py +73 -0
  132. lusid/models/eligibility_calculation.py +71 -0
  133. lusid/models/empty_model_options.py +3 -3
  134. lusid/models/equity.py +8 -6
  135. lusid/models/equity_curve_by_prices_data.py +3 -3
  136. lusid/models/equity_model_options.py +3 -3
  137. lusid/models/equity_option.py +3 -3
  138. lusid/models/equity_swap.py +4 -4
  139. lusid/models/equity_vol_surface_data.py +3 -3
  140. lusid/models/exchange_traded_option.py +3 -3
  141. lusid/models/exercise_event.py +5 -7
  142. lusid/models/exotic_instrument.py +3 -3
  143. lusid/models/filter_predicate_compliance_parameter.py +91 -0
  144. lusid/models/filter_step.py +101 -0
  145. lusid/models/fixed_leg.py +3 -3
  146. lusid/models/fixed_schedule.py +4 -9
  147. lusid/models/flexible_loan.py +105 -0
  148. lusid/models/float_schedule.py +20 -12
  149. lusid/models/floating_leg.py +3 -3
  150. lusid/models/flow_convention_name.py +1 -1
  151. lusid/models/flow_conventions.py +1 -1
  152. lusid/models/forward_rate_agreement.py +3 -3
  153. lusid/models/from_recipe.py +81 -0
  154. lusid/models/fund.py +182 -0
  155. lusid/models/fund_properties.py +115 -0
  156. lusid/models/fund_request.py +165 -0
  157. lusid/models/fund_share_class.py +99 -0
  158. lusid/models/funding_leg.py +3 -3
  159. lusid/models/funding_leg_options.py +3 -3
  160. lusid/models/future.py +3 -3
  161. lusid/models/fx_conventions.py +73 -0
  162. lusid/models/fx_forward.py +8 -6
  163. lusid/models/fx_forward_curve_by_quote_reference.py +4 -4
  164. lusid/models/fx_forward_curve_data.py +3 -3
  165. lusid/models/fx_forward_model_options.py +3 -3
  166. lusid/models/fx_forward_pips_curve_data.py +3 -3
  167. lusid/models/fx_forward_settlement_event.py +136 -0
  168. lusid/models/fx_forward_tenor_curve_data.py +4 -4
  169. lusid/models/fx_forward_tenor_pips_curve_data.py +4 -4
  170. lusid/models/fx_linked_notional_schedule.py +108 -0
  171. lusid/models/fx_option.py +3 -3
  172. lusid/models/fx_rate_schedule.py +3 -3
  173. lusid/models/fx_swap.py +4 -4
  174. lusid/models/fx_vol_surface_data.py +3 -3
  175. lusid/models/{reconciliation_run.py → get_recipe_composer_response.py} +15 -15
  176. lusid/models/group_by_selector_compliance_parameter.py +91 -0
  177. lusid/models/group_by_step.py +101 -0
  178. lusid/models/group_filter_predicate_compliance_parameter.py +91 -0
  179. lusid/models/group_filter_step.py +110 -0
  180. lusid/models/group_of_market_data_key_rules.py +79 -0
  181. lusid/models/index_convention.py +1 -1
  182. lusid/models/index_model_options.py +3 -3
  183. lusid/models/inflation_index_conventions.py +2 -2
  184. lusid/models/inflation_leg.py +3 -3
  185. lusid/models/inflation_linked_bond.py +3 -3
  186. lusid/models/inflation_swap.py +4 -4
  187. lusid/models/informational_error_event.py +3 -3
  188. lusid/models/informational_event.py +4 -6
  189. lusid/models/instrument_event.py +12 -5
  190. lusid/models/instrument_event_configuration.py +74 -0
  191. lusid/models/instrument_event_holder.py +12 -3
  192. lusid/models/instrument_event_type.py +7 -0
  193. lusid/models/instrument_leg.py +3 -3
  194. lusid/models/instrument_list_compliance_parameter.py +3 -3
  195. lusid/models/instrument_payment_diary_leg.py +5 -3
  196. lusid/models/instrument_resolution_detail.py +105 -0
  197. lusid/models/instrument_type.py +2 -0
  198. lusid/models/interest_rate_swap.py +4 -4
  199. lusid/models/interest_rate_swaption.py +3 -3
  200. lusid/models/intermediate_compliance_step.py +110 -0
  201. lusid/models/ir_vol_cube_data.py +3 -3
  202. lusid/models/journal_entry_line.py +34 -3
  203. lusid/models/journal_entry_lines_query_parameters.py +1 -1
  204. lusid/models/label_value_set.py +1 -1
  205. lusid/models/leg_definition.py +16 -3
  206. lusid/models/lineage_member.py +87 -0
  207. lusid/models/lock_period_diary_entry_request.py +91 -0
  208. lusid/models/lusid_instrument.py +7 -5
  209. lusid/models/lusid_trade_ticket.py +8 -1
  210. lusid/models/market_context.py +17 -2
  211. lusid/models/market_data_type.py +1 -0
  212. lusid/models/maturity_event.py +91 -0
  213. lusid/models/model_options.py +5 -6
  214. lusid/models/model_options_type.py +0 -1
  215. lusid/models/model_selection.py +3 -3
  216. lusid/models/move_orders_to_different_blocks_request.py +77 -0
  217. lusid/models/moved_order_to_different_block_response.py +85 -0
  218. lusid/models/movement_type.py +2 -0
  219. lusid/models/multi_currency_amounts.py +71 -0
  220. lusid/models/opaque_market_data.py +3 -3
  221. lusid/models/opaque_model_options.py +3 -3
  222. lusid/models/open_event.py +3 -3
  223. lusid/models/optionality_schedule.py +3 -3
  224. lusid/models/order_graph_block.py +4 -2
  225. lusid/models/order_graph_block_order_detail.py +16 -2
  226. lusid/models/paged_resource_list_of_cleardown_module_response.py +113 -0
  227. lusid/models/{paged_resource_list_of_reconciliation_run_break.py → paged_resource_list_of_cleardown_module_rule.py} +11 -11
  228. lusid/models/{paged_resource_list_of_reconciliation_run.py → paged_resource_list_of_fund.py} +11 -11
  229. lusid/models/paged_resource_list_of_property_definition.py +113 -0
  230. lusid/models/paged_resource_list_of_transaction_template.py +113 -0
  231. lusid/models/paged_resource_list_of_transaction_template_specification.py +113 -0
  232. lusid/models/participation_request.py +3 -9
  233. lusid/models/performance_returns_metric.py +1 -1
  234. lusid/models/period_diary_entries_reopened_response.py +104 -0
  235. lusid/models/place_blocks_request.py +77 -0
  236. lusid/models/portfolio.py +15 -2
  237. lusid/models/portfolio_details.py +15 -2
  238. lusid/models/portfolio_group_id_compliance_parameter.py +3 -3
  239. lusid/models/portfolio_group_id_list_compliance_parameter.py +3 -3
  240. lusid/models/portfolio_holding.py +27 -2
  241. lusid/models/portfolio_id_compliance_parameter.py +3 -3
  242. lusid/models/portfolio_id_list_compliance_parameter.py +3 -3
  243. lusid/models/posting_module_rule.py +29 -4
  244. lusid/models/pricing_model.py +2 -1
  245. lusid/models/property_definition.py +17 -4
  246. lusid/models/property_definition_search_result.py +3 -3
  247. lusid/models/property_domain.py +2 -0
  248. lusid/models/property_key_compliance_parameter.py +3 -3
  249. lusid/models/property_key_list_compliance_parameter.py +3 -3
  250. lusid/models/raw_vendor_event.py +5 -7
  251. lusid/models/re_open_period_diary_entry_request.py +84 -0
  252. lusid/models/recipe_block.py +87 -0
  253. lusid/models/recipe_composer.py +100 -0
  254. lusid/models/{reconciliation_break_id.py → recipe_value.py} +22 -23
  255. lusid/models/recombine_step.py +101 -0
  256. lusid/models/reference_instrument.py +3 -3
  257. lusid/models/relative_date_offset.py +71 -0
  258. lusid/models/repo.py +3 -3
  259. lusid/models/reset_event.py +4 -6
  260. lusid/models/resource_list_of_block_and_orders.py +113 -0
  261. lusid/models/resource_list_of_get_recipe_composer_response.py +113 -0
  262. lusid/models/resource_list_of_moved_order_to_different_block_response.py +113 -0
  263. lusid/models/schedule.py +6 -5
  264. lusid/models/schedule_type.py +1 -0
  265. lusid/models/script_map_reference.py +94 -0
  266. lusid/models/security_election.py +86 -0
  267. lusid/models/side_definition.py +1 -8
  268. lusid/models/sides_definition_request.py +1 -8
  269. lusid/models/simple_cash_flow_loan.py +3 -3
  270. lusid/models/simple_instrument.py +3 -3
  271. lusid/models/step_schedule.py +3 -3
  272. lusid/models/stock_split_event.py +3 -3
  273. lusid/models/string_compliance_parameter.py +3 -3
  274. lusid/models/string_list_compliance_parameter.py +3 -3
  275. lusid/models/template_field.py +77 -0
  276. lusid/models/term_deposit.py +3 -3
  277. lusid/models/total_return_swap.py +16 -16
  278. lusid/models/transaction_configuration_movement_data.py +3 -3
  279. lusid/models/transaction_configuration_movement_data_request.py +3 -3
  280. lusid/models/transaction_currency_and_amount.py +81 -0
  281. lusid/models/transaction_field_map.py +97 -0
  282. lusid/models/transaction_price.py +3 -3
  283. lusid/models/transaction_price_and_type.py +81 -0
  284. lusid/models/transaction_price_type.py +1 -0
  285. lusid/models/transaction_property_map.py +80 -0
  286. lusid/models/transaction_template.py +100 -0
  287. lusid/models/transaction_template_request.py +79 -0
  288. lusid/models/transaction_template_specification.py +99 -0
  289. lusid/models/transaction_type_alias.py +0 -7
  290. lusid/models/transaction_type_calculation.py +1 -1
  291. lusid/models/transition_event.py +3 -3
  292. lusid/models/translation_context.py +75 -0
  293. lusid/models/translation_script.py +9 -3
  294. lusid/models/trial_balance.py +46 -11
  295. lusid/models/trial_balance_query_parameters.py +15 -6
  296. lusid/models/trigger_event.py +3 -3
  297. lusid/models/units_ratio.py +71 -0
  298. lusid/models/{compliance_run_summary.py → upsert_compliance_run_summary_result.py} +8 -8
  299. lusid/models/upsert_dialect_request.py +79 -0
  300. lusid/models/upsert_instrument_event_request.py +12 -3
  301. lusid/models/upsert_quote_request.py +1 -1
  302. lusid/models/upsert_recipe_composer_request.py +73 -0
  303. lusid/models/upsert_recipe_request.py +3 -9
  304. lusid/models/upsert_translation_script_request.py +75 -0
  305. lusid/models/valuation_schedule.py +10 -3
  306. lusid/models/weighted_instrument.py +13 -2
  307. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +89 -0
  308. lusid/models/yield_curve_data.py +3 -3
  309. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.430.dist-info}/METADATA +227 -48
  310. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.430.dist-info}/RECORD +311 -233
  311. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.430.dist-info}/WHEEL +1 -1
  312. lusid/extensions/api_client_builder.py +0 -138
  313. lusid/models/configuration_recipe_snippet.py +0 -139
  314. lusid/models/je_lines_query_parameters.py +0 -105
  315. lusid/models/look_up_pricing_model_options.py +0 -93
  316. lusid/models/reconciliation_run_id.py +0 -85
  317. lusid/models/upsert_reconciliation_break_request.py +0 -98
lusid/api/abor_api.py CHANGED
@@ -29,14 +29,17 @@ from typing import Dict, Optional
29
29
  from lusid.models.abor import Abor
30
30
  from lusid.models.abor_properties import AborProperties
31
31
  from lusid.models.abor_request import AborRequest
32
+ from lusid.models.close_period_diary_entry_request import ClosePeriodDiaryEntryRequest
32
33
  from lusid.models.deleted_entity_response import DeletedEntityResponse
33
34
  from lusid.models.diary_entry import DiaryEntry
34
35
  from lusid.models.diary_entry_request import DiaryEntryRequest
35
- from lusid.models.je_lines_query_parameters import JELinesQueryParameters
36
36
  from lusid.models.journal_entry_lines_query_parameters import JournalEntryLinesQueryParameters
37
+ from lusid.models.lock_period_diary_entry_request import LockPeriodDiaryEntryRequest
37
38
  from lusid.models.model_property import ModelProperty
38
39
  from lusid.models.paged_resource_list_of_abor import PagedResourceListOfAbor
39
40
  from lusid.models.paged_resource_list_of_diary_entry import PagedResourceListOfDiaryEntry
41
+ from lusid.models.period_diary_entries_reopened_response import PeriodDiaryEntriesReopenedResponse
42
+ from lusid.models.re_open_period_diary_entry_request import ReOpenPeriodDiaryEntryRequest
40
43
  from lusid.models.trial_balance_query_parameters import TrialBalanceQueryParameters
41
44
  from lusid.models.versioned_resource_list_of_journal_entry_line import VersionedResourceListOfJournalEntryLine
42
45
  from lusid.models.versioned_resource_list_of_trial_balance import VersionedResourceListOfTrialBalance
@@ -244,28 +247,30 @@ class AborApi:
244
247
  _request_auth=_params.get('_request_auth'))
245
248
 
246
249
  @overload
247
- async def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], **kwargs) -> Abor: # noqa: E501
250
+ async def close_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], close_period_diary_entry_request : Annotated[ClosePeriodDiaryEntryRequest, Field(..., description="The request body, containing details to apply to the closing/locking period.")], **kwargs) -> DiaryEntry: # noqa: E501
248
251
  ...
249
252
 
250
253
  @overload
251
- def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], async_req: Optional[bool]=True, **kwargs) -> Abor: # noqa: E501
254
+ def close_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], close_period_diary_entry_request : Annotated[ClosePeriodDiaryEntryRequest, Field(..., description="The request body, containing details to apply to the closing/locking period.")], async_req: Optional[bool]=True, **kwargs) -> DiaryEntry: # noqa: E501
252
255
  ...
253
256
 
254
257
  @validate_arguments
255
- def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], async_req: Optional[bool]=None, **kwargs) -> Union[Abor, Awaitable[Abor]]: # noqa: E501
256
- """[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501
258
+ def close_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], close_period_diary_entry_request : Annotated[ClosePeriodDiaryEntryRequest, Field(..., description="The request body, containing details to apply to the closing/locking period.")], async_req: Optional[bool]=None, **kwargs) -> Union[DiaryEntry, Awaitable[DiaryEntry]]: # noqa: E501
259
+ """[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. # noqa: E501
257
260
 
258
- Create the given Abor. # noqa: E501
261
+ Closes or Locks the current open period for the given Abor. # noqa: E501
259
262
  This method makes a synchronous HTTP request by default. To make an
260
263
  asynchronous HTTP request, please pass async_req=True
261
264
 
262
- >>> thread = api.create_abor(scope, abor_request, async_req=True)
265
+ >>> thread = api.close_period(scope, code, close_period_diary_entry_request, async_req=True)
263
266
  >>> result = thread.get()
264
267
 
265
268
  :param scope: The scope of the Abor. (required)
266
269
  :type scope: str
267
- :param abor_request: The definition of the Abor. (required)
268
- :type abor_request: AborRequest
270
+ :param code: The code of the Abor. (required)
271
+ :type code: str
272
+ :param close_period_diary_entry_request: The request body, containing details to apply to the closing/locking period. (required)
273
+ :type close_period_diary_entry_request: ClosePeriodDiaryEntryRequest
269
274
  :param async_req: Whether to execute the request asynchronously.
270
275
  :type async_req: bool, optional
271
276
  :param _request_timeout: timeout setting for this request.
@@ -275,31 +280,33 @@ class AborApi:
275
280
  :return: Returns the result object.
276
281
  If the method is called asynchronously,
277
282
  returns the request thread.
278
- :rtype: Abor
283
+ :rtype: DiaryEntry
279
284
  """
280
285
  kwargs['_return_http_data_only'] = True
281
286
  if '_preload_content' in kwargs:
282
- message = "Error! Please call the create_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
287
+ message = "Error! Please call the close_period_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
283
288
  raise ValueError(message)
284
289
  if async_req is not None:
285
290
  kwargs['async_req'] = async_req
286
- return self.create_abor_with_http_info(scope, abor_request, **kwargs) # noqa: E501
291
+ return self.close_period_with_http_info(scope, code, close_period_diary_entry_request, **kwargs) # noqa: E501
287
292
 
288
293
  @validate_arguments
289
- def create_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], **kwargs) -> ApiResponse: # noqa: E501
290
- """[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501
294
+ def close_period_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], close_period_diary_entry_request : Annotated[ClosePeriodDiaryEntryRequest, Field(..., description="The request body, containing details to apply to the closing/locking period.")], **kwargs) -> ApiResponse: # noqa: E501
295
+ """[EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. # noqa: E501
291
296
 
292
- Create the given Abor. # noqa: E501
297
+ Closes or Locks the current open period for the given Abor. # noqa: E501
293
298
  This method makes a synchronous HTTP request by default. To make an
294
299
  asynchronous HTTP request, please pass async_req=True
295
300
 
296
- >>> thread = api.create_abor_with_http_info(scope, abor_request, async_req=True)
301
+ >>> thread = api.close_period_with_http_info(scope, code, close_period_diary_entry_request, async_req=True)
297
302
  >>> result = thread.get()
298
303
 
299
304
  :param scope: The scope of the Abor. (required)
300
305
  :type scope: str
301
- :param abor_request: The definition of the Abor. (required)
302
- :type abor_request: AborRequest
306
+ :param code: The code of the Abor. (required)
307
+ :type code: str
308
+ :param close_period_diary_entry_request: The request body, containing details to apply to the closing/locking period. (required)
309
+ :type close_period_diary_entry_request: ClosePeriodDiaryEntryRequest
303
310
  :param async_req: Whether to execute the request asynchronously.
304
311
  :type async_req: bool, optional
305
312
  :param _preload_content: if False, the ApiResponse.data will
@@ -322,14 +329,15 @@ class AborApi:
322
329
  :return: Returns the result object.
323
330
  If the method is called asynchronously,
324
331
  returns the request thread.
325
- :rtype: tuple(Abor, status_code(int), headers(HTTPHeaderDict))
332
+ :rtype: tuple(DiaryEntry, status_code(int), headers(HTTPHeaderDict))
326
333
  """
327
334
 
328
335
  _params = locals()
329
336
 
330
337
  _all_params = [
331
338
  'scope',
332
- 'abor_request'
339
+ 'code',
340
+ 'close_period_diary_entry_request'
333
341
  ]
334
342
  _all_params.extend(
335
343
  [
@@ -348,7 +356,7 @@ class AborApi:
348
356
  if _key not in _all_params:
349
357
  raise ApiTypeError(
350
358
  "Got an unexpected keyword argument '%s'"
351
- " to method create_abor" % _key
359
+ " to method close_period" % _key
352
360
  )
353
361
  _params[_key] = _val
354
362
  del _params['kwargs']
@@ -360,6 +368,9 @@ class AborApi:
360
368
  if _params['scope']:
361
369
  _path_params['scope'] = _params['scope']
362
370
 
371
+ if _params['code']:
372
+ _path_params['code'] = _params['code']
373
+
363
374
 
364
375
  # process the query parameters
365
376
  _query_params = []
@@ -370,8 +381,8 @@ class AborApi:
370
381
  _files = {}
371
382
  # process the body parameter
372
383
  _body_params = None
373
- if _params['abor_request'] is not None:
374
- _body_params = _params['abor_request']
384
+ if _params['close_period_diary_entry_request'] is not None:
385
+ _body_params = _params['close_period_diary_entry_request']
375
386
 
376
387
  # set the HTTP header `Accept`
377
388
  _header_params['Accept'] = self.api_client.select_header_accept(
@@ -388,12 +399,12 @@ class AborApi:
388
399
  _auth_settings = ['oauth2'] # noqa: E501
389
400
 
390
401
  _response_types_map = {
391
- '201': "Abor",
402
+ '201': "DiaryEntry",
392
403
  '400': "LusidValidationProblemDetails",
393
404
  }
394
405
 
395
406
  return self.api_client.call_api(
396
- '/api/abor/{scope}', 'POST',
407
+ '/api/abor/{scope}/{code}/accountingdiary/$closeperiod', 'POST',
397
408
  _path_params,
398
409
  _query_params,
399
410
  _header_params,
@@ -410,28 +421,28 @@ class AborApi:
410
421
  _request_auth=_params.get('_request_auth'))
411
422
 
412
423
  @overload
413
- async def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
424
+ async def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], **kwargs) -> Abor: # noqa: E501
414
425
  ...
415
426
 
416
427
  @overload
417
- def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
428
+ def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], async_req: Optional[bool]=True, **kwargs) -> Abor: # noqa: E501
418
429
  ...
419
430
 
420
431
  @validate_arguments
421
- def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
422
- """[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501
432
+ def create_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], async_req: Optional[bool]=None, **kwargs) -> Union[Abor, Awaitable[Abor]]: # noqa: E501
433
+ """[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501
423
434
 
424
- Delete the given Abor. # noqa: E501
435
+ Create the given Abor. # noqa: E501
425
436
  This method makes a synchronous HTTP request by default. To make an
426
437
  asynchronous HTTP request, please pass async_req=True
427
438
 
428
- >>> thread = api.delete_abor(scope, code, async_req=True)
439
+ >>> thread = api.create_abor(scope, abor_request, async_req=True)
429
440
  >>> result = thread.get()
430
441
 
431
- :param scope: The scope of the Abor to be deleted. (required)
442
+ :param scope: The scope of the Abor. (required)
432
443
  :type scope: str
433
- :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
434
- :type code: str
444
+ :param abor_request: The definition of the Abor. (required)
445
+ :type abor_request: AborRequest
435
446
  :param async_req: Whether to execute the request asynchronously.
436
447
  :type async_req: bool, optional
437
448
  :param _request_timeout: timeout setting for this request.
@@ -441,31 +452,31 @@ class AborApi:
441
452
  :return: Returns the result object.
442
453
  If the method is called asynchronously,
443
454
  returns the request thread.
444
- :rtype: DeletedEntityResponse
455
+ :rtype: Abor
445
456
  """
446
457
  kwargs['_return_http_data_only'] = True
447
458
  if '_preload_content' in kwargs:
448
- message = "Error! Please call the delete_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
459
+ message = "Error! Please call the create_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
449
460
  raise ValueError(message)
450
461
  if async_req is not None:
451
462
  kwargs['async_req'] = async_req
452
- return self.delete_abor_with_http_info(scope, code, **kwargs) # noqa: E501
463
+ return self.create_abor_with_http_info(scope, abor_request, **kwargs) # noqa: E501
453
464
 
454
465
  @validate_arguments
455
- def delete_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], **kwargs) -> ApiResponse: # noqa: E501
456
- """[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501
466
+ def create_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], abor_request : Annotated[AborRequest, Field(..., description="The definition of the Abor.")], **kwargs) -> ApiResponse: # noqa: E501
467
+ """[EXPERIMENTAL] CreateAbor: Create an Abor. # noqa: E501
457
468
 
458
- Delete the given Abor. # noqa: E501
469
+ Create the given Abor. # noqa: E501
459
470
  This method makes a synchronous HTTP request by default. To make an
460
471
  asynchronous HTTP request, please pass async_req=True
461
472
 
462
- >>> thread = api.delete_abor_with_http_info(scope, code, async_req=True)
473
+ >>> thread = api.create_abor_with_http_info(scope, abor_request, async_req=True)
463
474
  >>> result = thread.get()
464
475
 
465
- :param scope: The scope of the Abor to be deleted. (required)
476
+ :param scope: The scope of the Abor. (required)
466
477
  :type scope: str
467
- :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
468
- :type code: str
478
+ :param abor_request: The definition of the Abor. (required)
479
+ :type abor_request: AborRequest
469
480
  :param async_req: Whether to execute the request asynchronously.
470
481
  :type async_req: bool, optional
471
482
  :param _preload_content: if False, the ApiResponse.data will
@@ -488,14 +499,14 @@ class AborApi:
488
499
  :return: Returns the result object.
489
500
  If the method is called asynchronously,
490
501
  returns the request thread.
491
- :rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
502
+ :rtype: tuple(Abor, status_code(int), headers(HTTPHeaderDict))
492
503
  """
493
504
 
494
505
  _params = locals()
495
506
 
496
507
  _all_params = [
497
508
  'scope',
498
- 'code'
509
+ 'abor_request'
499
510
  ]
500
511
  _all_params.extend(
501
512
  [
@@ -514,7 +525,7 @@ class AborApi:
514
525
  if _key not in _all_params:
515
526
  raise ApiTypeError(
516
527
  "Got an unexpected keyword argument '%s'"
517
- " to method delete_abor" % _key
528
+ " to method create_abor" % _key
518
529
  )
519
530
  _params[_key] = _val
520
531
  del _params['kwargs']
@@ -526,9 +537,6 @@ class AborApi:
526
537
  if _params['scope']:
527
538
  _path_params['scope'] = _params['scope']
528
539
 
529
- if _params['code']:
530
- _path_params['code'] = _params['code']
531
-
532
540
 
533
541
  # process the query parameters
534
542
  _query_params = []
@@ -539,20 +547,30 @@ class AborApi:
539
547
  _files = {}
540
548
  # process the body parameter
541
549
  _body_params = None
550
+ if _params['abor_request'] is not None:
551
+ _body_params = _params['abor_request']
552
+
542
553
  # set the HTTP header `Accept`
543
554
  _header_params['Accept'] = self.api_client.select_header_accept(
544
555
  ['text/plain', 'application/json', 'text/json']) # noqa: E501
545
556
 
557
+ # set the HTTP header `Content-Type`
558
+ _content_types_list = _params.get('_content_type',
559
+ self.api_client.select_header_content_type(
560
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
561
+ if _content_types_list:
562
+ _header_params['Content-Type'] = _content_types_list
563
+
546
564
  # authentication setting
547
565
  _auth_settings = ['oauth2'] # noqa: E501
548
566
 
549
567
  _response_types_map = {
550
- '200': "DeletedEntityResponse",
568
+ '201': "Abor",
551
569
  '400': "LusidValidationProblemDetails",
552
570
  }
553
571
 
554
572
  return self.api_client.call_api(
555
- '/api/abor/{scope}/{code}', 'DELETE',
573
+ '/api/abor/{scope}', 'POST',
556
574
  _path_params,
557
575
  _query_params,
558
576
  _header_params,
@@ -569,34 +587,28 @@ class AborApi:
569
587
  _request_auth=_params.get('_request_auth'))
570
588
 
571
589
  @overload
572
- async def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.")] = None, **kwargs) -> Abor: # noqa: E501
590
+ async def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
573
591
  ...
574
592
 
575
593
  @overload
576
- def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.")] = None, async_req: Optional[bool]=True, **kwargs) -> Abor: # noqa: E501
594
+ def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
577
595
  ...
578
596
 
579
597
  @validate_arguments
580
- def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Abor, Awaitable[Abor]]: # noqa: E501
581
- """[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501
598
+ def delete_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
599
+ """[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501
582
600
 
583
- Retrieve the definition of a particular Abor. # noqa: E501
601
+ Delete the given Abor. # noqa: E501
584
602
  This method makes a synchronous HTTP request by default. To make an
585
603
  asynchronous HTTP request, please pass async_req=True
586
604
 
587
- >>> thread = api.get_abor(scope, code, effective_at, as_at, property_keys, async_req=True)
605
+ >>> thread = api.delete_abor(scope, code, async_req=True)
588
606
  >>> result = thread.get()
589
607
 
590
- :param scope: The scope of the Abor. (required)
608
+ :param scope: The scope of the Abor to be deleted. (required)
591
609
  :type scope: str
592
- :param code: The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
610
+ :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
593
611
  :type code: str
594
- :param effective_at: The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
595
- :type effective_at: str
596
- :param as_at: The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
597
- :type as_at: datetime
598
- :param property_keys: A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.
599
- :type property_keys: List[str]
600
612
  :param async_req: Whether to execute the request asynchronously.
601
613
  :type async_req: bool, optional
602
614
  :param _request_timeout: timeout setting for this request.
@@ -606,37 +618,31 @@ class AborApi:
606
618
  :return: Returns the result object.
607
619
  If the method is called asynchronously,
608
620
  returns the request thread.
609
- :rtype: Abor
621
+ :rtype: DeletedEntityResponse
610
622
  """
611
623
  kwargs['_return_http_data_only'] = True
612
624
  if '_preload_content' in kwargs:
613
- message = "Error! Please call the get_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
625
+ message = "Error! Please call the delete_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
614
626
  raise ValueError(message)
615
627
  if async_req is not None:
616
628
  kwargs['async_req'] = async_req
617
- return self.get_abor_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
629
+ return self.delete_abor_with_http_info(scope, code, **kwargs) # noqa: E501
618
630
 
619
631
  @validate_arguments
620
- def get_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.")] = None, **kwargs) -> ApiResponse: # noqa: E501
621
- """[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501
632
+ def delete_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], **kwargs) -> ApiResponse: # noqa: E501
633
+ """[EXPERIMENTAL] DeleteAbor: Delete an Abor. # noqa: E501
622
634
 
623
- Retrieve the definition of a particular Abor. # noqa: E501
635
+ Delete the given Abor. # noqa: E501
624
636
  This method makes a synchronous HTTP request by default. To make an
625
637
  asynchronous HTTP request, please pass async_req=True
626
638
 
627
- >>> thread = api.get_abor_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True)
639
+ >>> thread = api.delete_abor_with_http_info(scope, code, async_req=True)
628
640
  >>> result = thread.get()
629
641
 
630
- :param scope: The scope of the Abor. (required)
642
+ :param scope: The scope of the Abor to be deleted. (required)
631
643
  :type scope: str
632
- :param code: The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
644
+ :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
633
645
  :type code: str
634
- :param effective_at: The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
635
- :type effective_at: str
636
- :param as_at: The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
637
- :type as_at: datetime
638
- :param property_keys: A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If not provided will return all the entitled properties for that Abor.
639
- :type property_keys: List[str]
640
646
  :param async_req: Whether to execute the request asynchronously.
641
647
  :type async_req: bool, optional
642
648
  :param _preload_content: if False, the ApiResponse.data will
@@ -659,17 +665,14 @@ class AborApi:
659
665
  :return: Returns the result object.
660
666
  If the method is called asynchronously,
661
667
  returns the request thread.
662
- :rtype: tuple(Abor, status_code(int), headers(HTTPHeaderDict))
668
+ :rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
663
669
  """
664
670
 
665
671
  _params = locals()
666
672
 
667
673
  _all_params = [
668
674
  'scope',
669
- 'code',
670
- 'effective_at',
671
- 'as_at',
672
- 'property_keys'
675
+ 'code'
673
676
  ]
674
677
  _all_params.extend(
675
678
  [
@@ -688,7 +691,7 @@ class AborApi:
688
691
  if _key not in _all_params:
689
692
  raise ApiTypeError(
690
693
  "Got an unexpected keyword argument '%s'"
691
- " to method get_abor" % _key
694
+ " to method delete_abor" % _key
692
695
  )
693
696
  _params[_key] = _val
694
697
  del _params['kwargs']
@@ -706,19 +709,6 @@ class AborApi:
706
709
 
707
710
  # process the query parameters
708
711
  _query_params = []
709
- if _params.get('effective_at') is not None: # noqa: E501
710
- _query_params.append(('effectiveAt', _params['effective_at']))
711
-
712
- if _params.get('as_at') is not None: # noqa: E501
713
- if isinstance(_params['as_at'], datetime):
714
- _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
715
- else:
716
- _query_params.append(('asAt', _params['as_at']))
717
-
718
- if _params.get('property_keys') is not None: # noqa: E501
719
- _query_params.append(('propertyKeys', _params['property_keys']))
720
- _collection_formats['propertyKeys'] = 'multi'
721
-
722
712
  # process the header parameters
723
713
  _header_params = dict(_params.get('_headers', {}))
724
714
  # process the form parameters
@@ -734,12 +724,12 @@ class AborApi:
734
724
  _auth_settings = ['oauth2'] # noqa: E501
735
725
 
736
726
  _response_types_map = {
737
- '200': "Abor",
727
+ '200': "DeletedEntityResponse",
738
728
  '400': "LusidValidationProblemDetails",
739
729
  }
740
730
 
741
731
  return self.api_client.call_api(
742
- '/api/abor/{scope}/{code}', 'GET',
732
+ '/api/abor/{scope}/{code}', 'DELETE',
743
733
  _path_params,
744
734
  _query_params,
745
735
  _header_params,
@@ -756,36 +746,34 @@ class AborApi:
756
746
  _request_auth=_params.get('_request_auth'))
757
747
 
758
748
  @overload
759
- async def get_je_lines(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.")], je_lines_query_parameters : Annotated[JELinesQueryParameters, Field(..., description="The query parameters used in running the generation of the JELines.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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 JELines from a previous call to GetJELines.")] = None, **kwargs) -> VersionedResourceListOfJournalEntryLine: # noqa: E501
749
+ async def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> Abor: # noqa: E501
760
750
  ...
761
751
 
762
752
  @overload
763
- def get_je_lines(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.")], je_lines_query_parameters : Annotated[JELinesQueryParameters, Field(..., description="The query parameters used in running the generation of the JELines.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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 JELines from a previous call to GetJELines.")] = None, async_req: Optional[bool]=True, **kwargs) -> VersionedResourceListOfJournalEntryLine: # noqa: E501
753
+ def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=True, **kwargs) -> Abor: # noqa: E501
764
754
  ...
765
755
 
766
756
  @validate_arguments
767
- def get_je_lines(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.")], je_lines_query_parameters : Annotated[JELinesQueryParameters, Field(..., description="The query parameters used in running the generation of the JELines.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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 JELines from a previous call to GetJELines.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[VersionedResourceListOfJournalEntryLine, Awaitable[VersionedResourceListOfJournalEntryLine]]: # noqa: E501
768
- """[DEPRECATED] GetJELines: DEPRECATED: please use GetJournalEntryLines instead. Get the JELines for the given Abor. # noqa: E501
757
+ def get_abor(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Abor, Awaitable[Abor]]: # noqa: E501
758
+ """[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501
769
759
 
770
- DEPRECATED: please use GetJournalEntryLines instead. Gets the JELines for the given Abor The JE Lines have been generated from transactions and translated via posting rules # noqa: E501
760
+ Retrieve the definition of a particular Abor. # noqa: E501
771
761
  This method makes a synchronous HTTP request by default. To make an
772
762
  asynchronous HTTP request, please pass async_req=True
773
763
 
774
- >>> thread = api.get_je_lines(scope, code, je_lines_query_parameters, as_at, limit, page, async_req=True)
764
+ >>> thread = api.get_abor(scope, code, effective_at, as_at, property_keys, async_req=True)
775
765
  >>> result = thread.get()
776
766
 
777
767
  :param scope: The scope of the Abor. (required)
778
768
  :type scope: str
779
- :param code: The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. (required)
769
+ :param code: The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
780
770
  :type code: str
781
- :param je_lines_query_parameters: The query parameters used in running the generation of the JELines. (required)
782
- :type je_lines_query_parameters: JELinesQueryParameters
783
- :param as_at: The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.
771
+ :param effective_at: The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
772
+ :type effective_at: str
773
+ :param as_at: The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
784
774
  :type as_at: datetime
785
- :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
786
- :type limit: int
787
- :param page: The pagination token to use to continue listing JELines from a previous call to GetJELines.
788
- :type page: str
775
+ :param property_keys: A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.
776
+ :type property_keys: List[str]
789
777
  :param async_req: Whether to execute the request asynchronously.
790
778
  :type async_req: bool, optional
791
779
  :param _request_timeout: timeout setting for this request.
@@ -795,39 +783,37 @@ class AborApi:
795
783
  :return: Returns the result object.
796
784
  If the method is called asynchronously,
797
785
  returns the request thread.
798
- :rtype: VersionedResourceListOfJournalEntryLine
786
+ :rtype: Abor
799
787
  """
800
788
  kwargs['_return_http_data_only'] = True
801
789
  if '_preload_content' in kwargs:
802
- message = "Error! Please call the get_je_lines_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
790
+ message = "Error! Please call the get_abor_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
803
791
  raise ValueError(message)
804
792
  if async_req is not None:
805
793
  kwargs['async_req'] = async_req
806
- return self.get_je_lines_with_http_info(scope, code, je_lines_query_parameters, as_at, limit, page, **kwargs) # noqa: E501
794
+ return self.get_abor_with_http_info(scope, code, effective_at, as_at, property_keys, **kwargs) # noqa: E501
807
795
 
808
796
  @validate_arguments
809
- def get_je_lines_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope is creating the unique identifier for the given Abor.")], je_lines_query_parameters : Annotated[JELinesQueryParameters, Field(..., description="The query parameters used in running the generation of the JELines.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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 JELines from a previous call to GetJELines.")] = None, **kwargs) -> ApiResponse: # noqa: E501
810
- """[DEPRECATED] GetJELines: DEPRECATED: please use GetJournalEntryLines instead. Get the JELines for the given Abor. # noqa: E501
797
+ def get_abor_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor. Together with the scope this uniquely identifies the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Abor properties. 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 Abor definition. Defaults to returning the latest version of the Abor definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.")] = None, **kwargs) -> ApiResponse: # noqa: E501
798
+ """[EXPERIMENTAL] GetAbor: Get Abor. # noqa: E501
811
799
 
812
- DEPRECATED: please use GetJournalEntryLines instead. Gets the JELines for the given Abor The JE Lines have been generated from transactions and translated via posting rules # noqa: E501
800
+ Retrieve the definition of a particular Abor. # noqa: E501
813
801
  This method makes a synchronous HTTP request by default. To make an
814
802
  asynchronous HTTP request, please pass async_req=True
815
803
 
816
- >>> thread = api.get_je_lines_with_http_info(scope, code, je_lines_query_parameters, as_at, limit, page, async_req=True)
804
+ >>> thread = api.get_abor_with_http_info(scope, code, effective_at, as_at, property_keys, async_req=True)
817
805
  >>> result = thread.get()
818
806
 
819
807
  :param scope: The scope of the Abor. (required)
820
808
  :type scope: str
821
- :param code: The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. (required)
809
+ :param code: The code of the Abor. Together with the scope this uniquely identifies the Abor. (required)
822
810
  :type code: str
823
- :param je_lines_query_parameters: The query parameters used in running the generation of the JELines. (required)
824
- :type je_lines_query_parameters: JELinesQueryParameters
825
- :param as_at: The asAt datetime at which to retrieve JELines. Defaults to returning the latest version of each transaction if not specified.
811
+ :param effective_at: The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified.
812
+ :type effective_at: str
813
+ :param as_at: The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified.
826
814
  :type as_at: datetime
827
- :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
828
- :type limit: int
829
- :param page: The pagination token to use to continue listing JELines from a previous call to GetJELines.
830
- :type page: str
815
+ :param property_keys: A list of property keys from the 'Abor' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'. If no properties are specified, then no properties will be returned.
816
+ :type property_keys: List[str]
831
817
  :param async_req: Whether to execute the request asynchronously.
832
818
  :type async_req: bool, optional
833
819
  :param _preload_content: if False, the ApiResponse.data will
@@ -850,7 +836,7 @@ class AborApi:
850
836
  :return: Returns the result object.
851
837
  If the method is called asynchronously,
852
838
  returns the request thread.
853
- :rtype: tuple(VersionedResourceListOfJournalEntryLine, status_code(int), headers(HTTPHeaderDict))
839
+ :rtype: tuple(Abor, status_code(int), headers(HTTPHeaderDict))
854
840
  """
855
841
 
856
842
  _params = locals()
@@ -858,10 +844,9 @@ class AborApi:
858
844
  _all_params = [
859
845
  'scope',
860
846
  'code',
861
- 'je_lines_query_parameters',
847
+ 'effective_at',
862
848
  'as_at',
863
- 'limit',
864
- 'page'
849
+ 'property_keys'
865
850
  ]
866
851
  _all_params.extend(
867
852
  [
@@ -880,7 +865,7 @@ class AborApi:
880
865
  if _key not in _all_params:
881
866
  raise ApiTypeError(
882
867
  "Got an unexpected keyword argument '%s'"
883
- " to method get_je_lines" % _key
868
+ " to method get_abor" % _key
884
869
  )
885
870
  _params[_key] = _val
886
871
  del _params['kwargs']
@@ -898,17 +883,18 @@ class AborApi:
898
883
 
899
884
  # process the query parameters
900
885
  _query_params = []
886
+ if _params.get('effective_at') is not None: # noqa: E501
887
+ _query_params.append(('effectiveAt', _params['effective_at']))
888
+
901
889
  if _params.get('as_at') is not None: # noqa: E501
902
890
  if isinstance(_params['as_at'], datetime):
903
891
  _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
904
892
  else:
905
893
  _query_params.append(('asAt', _params['as_at']))
906
894
 
907
- if _params.get('limit') is not None: # noqa: E501
908
- _query_params.append(('limit', _params['limit']))
909
-
910
- if _params.get('page') is not None: # noqa: E501
911
- _query_params.append(('page', _params['page']))
895
+ if _params.get('property_keys') is not None: # noqa: E501
896
+ _query_params.append(('propertyKeys', _params['property_keys']))
897
+ _collection_formats['propertyKeys'] = 'multi'
912
898
 
913
899
  # process the header parameters
914
900
  _header_params = dict(_params.get('_headers', {}))
@@ -917,30 +903,20 @@ class AborApi:
917
903
  _files = {}
918
904
  # process the body parameter
919
905
  _body_params = None
920
- if _params['je_lines_query_parameters'] is not None:
921
- _body_params = _params['je_lines_query_parameters']
922
-
923
906
  # set the HTTP header `Accept`
924
907
  _header_params['Accept'] = self.api_client.select_header_accept(
925
908
  ['text/plain', 'application/json', 'text/json']) # noqa: E501
926
909
 
927
- # set the HTTP header `Content-Type`
928
- _content_types_list = _params.get('_content_type',
929
- self.api_client.select_header_content_type(
930
- ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
931
- if _content_types_list:
932
- _header_params['Content-Type'] = _content_types_list
933
-
934
910
  # authentication setting
935
911
  _auth_settings = ['oauth2'] # noqa: E501
936
912
 
937
913
  _response_types_map = {
938
- '200': "VersionedResourceListOfJournalEntryLine",
914
+ '200': "Abor",
939
915
  '400': "LusidValidationProblemDetails",
940
916
  }
941
917
 
942
918
  return self.api_client.call_api(
943
- '/api/abor/{scope}/{code}/JELines/$query/$deprecated', 'POST',
919
+ '/api/abor/{scope}/{code}', 'GET',
944
920
  _path_params,
945
921
  _query_params,
946
922
  _header_params,
@@ -1375,36 +1351,36 @@ class AborApi:
1375
1351
  _request_auth=_params.get('_request_auth'))
1376
1352
 
1377
1353
  @overload
1378
- async def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, start : Annotated[Optional[StrictInt], Field(description="When paginating, skip this number of results.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, **kwargs) -> PagedResourceListOfAbor: # noqa: E501
1354
+ async def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, **kwargs) -> PagedResourceListOfAbor: # noqa: E501
1379
1355
  ...
1380
1356
 
1381
1357
  @overload
1382
- def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, start : Annotated[Optional[StrictInt], Field(description="When paginating, skip this number of results.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfAbor: # noqa: E501
1358
+ def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfAbor: # noqa: E501
1383
1359
  ...
1384
1360
 
1385
1361
  @validate_arguments
1386
- def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, start : Annotated[Optional[StrictInt], Field(description="When paginating, skip this number of results.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfAbor, Awaitable[PagedResourceListOfAbor]]: # noqa: E501
1362
+ def list_abors(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfAbor, Awaitable[PagedResourceListOfAbor]]: # noqa: E501
1387
1363
  """[EXPERIMENTAL] ListAbors: List Abors. # noqa: E501
1388
1364
 
1389
1365
  List all the Abors matching particular criteria. # noqa: E501
1390
1366
  This method makes a synchronous HTTP request by default. To make an
1391
1367
  asynchronous HTTP request, please pass async_req=True
1392
1368
 
1393
- >>> thread = api.list_abors(effective_at, as_at, page, start, limit, filter, property_keys, async_req=True)
1369
+ >>> thread = api.list_abors(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
1394
1370
  >>> result = thread.get()
1395
1371
 
1396
1372
  :param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the Abor. Defaults to the current LUSID system datetime if not specified.
1397
1373
  :type effective_at: str
1398
1374
  :param as_at: The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified.
1399
1375
  :type as_at: datetime
1400
- :param page: The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.
1376
+ :param page: The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1401
1377
  :type page: str
1402
- :param start: When paginating, skip this number of results.
1403
- :type start: int
1404
1378
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1405
1379
  :type limit: int
1406
1380
  :param filter: Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1407
1381
  :type filter: str
1382
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1383
+ :type sort_by: List[str]
1408
1384
  :param property_keys: A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.
1409
1385
  :type property_keys: List[str]
1410
1386
  :param async_req: Whether to execute the request asynchronously.
@@ -1424,31 +1400,31 @@ class AborApi:
1424
1400
  raise ValueError(message)
1425
1401
  if async_req is not None:
1426
1402
  kwargs['async_req'] = async_req
1427
- return self.list_abors_with_http_info(effective_at, as_at, page, start, limit, filter, property_keys, **kwargs) # noqa: E501
1403
+ return self.list_abors_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
1428
1404
 
1429
1405
  @validate_arguments
1430
- def list_abors_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, start : Annotated[Optional[StrictInt], Field(description="When paginating, skip this number of results.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1406
+ def list_abors_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Abor. 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 Abor. Defaults to returning the latest version of each Abor 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 Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1431
1407
  """[EXPERIMENTAL] ListAbors: List Abors. # noqa: E501
1432
1408
 
1433
1409
  List all the Abors matching particular criteria. # noqa: E501
1434
1410
  This method makes a synchronous HTTP request by default. To make an
1435
1411
  asynchronous HTTP request, please pass async_req=True
1436
1412
 
1437
- >>> thread = api.list_abors_with_http_info(effective_at, as_at, page, start, limit, filter, property_keys, async_req=True)
1413
+ >>> thread = api.list_abors_with_http_info(effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
1438
1414
  >>> result = thread.get()
1439
1415
 
1440
1416
  :param effective_at: The effective datetime or cut label at which to list the TimeVariant properties for the Abor. Defaults to the current LUSID system datetime if not specified.
1441
1417
  :type effective_at: str
1442
1418
  :param as_at: The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified.
1443
1419
  :type as_at: datetime
1444
- :param page: The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.
1420
+ :param page: The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1445
1421
  :type page: str
1446
- :param start: When paginating, skip this number of results.
1447
- :type start: int
1448
1422
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1449
1423
  :type limit: int
1450
1424
  :param filter: Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq 'Abor1'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1451
1425
  :type filter: str
1426
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1427
+ :type sort_by: List[str]
1452
1428
  :param property_keys: A list of property keys from the 'Abor' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example 'Abor/Manager/Id'.
1453
1429
  :type property_keys: List[str]
1454
1430
  :param async_req: Whether to execute the request asynchronously.
@@ -1482,9 +1458,9 @@ class AborApi:
1482
1458
  'effective_at',
1483
1459
  'as_at',
1484
1460
  'page',
1485
- 'start',
1486
1461
  'limit',
1487
1462
  'filter',
1463
+ 'sort_by',
1488
1464
  'property_keys'
1489
1465
  ]
1490
1466
  _all_params.extend(
@@ -1528,15 +1504,16 @@ class AborApi:
1528
1504
  if _params.get('page') is not None: # noqa: E501
1529
1505
  _query_params.append(('page', _params['page']))
1530
1506
 
1531
- if _params.get('start') is not None: # noqa: E501
1532
- _query_params.append(('start', _params['start']))
1533
-
1534
1507
  if _params.get('limit') is not None: # noqa: E501
1535
1508
  _query_params.append(('limit', _params['limit']))
1536
1509
 
1537
1510
  if _params.get('filter') is not None: # noqa: E501
1538
1511
  _query_params.append(('filter', _params['filter']))
1539
1512
 
1513
+ if _params.get('sort_by') is not None: # noqa: E501
1514
+ _query_params.append(('sortBy', _params['sort_by']))
1515
+ _collection_formats['sortBy'] = 'multi'
1516
+
1540
1517
  if _params.get('property_keys') is not None: # noqa: E501
1541
1518
  _query_params.append(('propertyKeys', _params['property_keys']))
1542
1519
  _collection_formats['propertyKeys'] = 'multi'
@@ -1578,22 +1555,22 @@ class AborApi:
1578
1555
  _request_auth=_params.get('_request_auth'))
1579
1556
 
1580
1557
  @overload
1581
- async def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, **kwargs) -> PagedResourceListOfDiaryEntry: # noqa: E501
1558
+ async def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, **kwargs) -> PagedResourceListOfDiaryEntry: # noqa: E501
1582
1559
  ...
1583
1560
 
1584
1561
  @overload
1585
- def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfDiaryEntry: # noqa: E501
1562
+ def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfDiaryEntry: # noqa: E501
1586
1563
  ...
1587
1564
 
1588
1565
  @validate_arguments
1589
- def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfDiaryEntry, Awaitable[PagedResourceListOfDiaryEntry]]: # noqa: E501
1566
+ def list_diary_entries(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfDiaryEntry, Awaitable[PagedResourceListOfDiaryEntry]]: # noqa: E501
1590
1567
  """[EXPERIMENTAL] ListDiaryEntries: List diary entries. # noqa: E501
1591
1568
 
1592
1569
  List all the diary entries matching particular criteria. # noqa: E501
1593
1570
  This method makes a synchronous HTTP request by default. To make an
1594
1571
  asynchronous HTTP request, please pass async_req=True
1595
1572
 
1596
- >>> thread = api.list_diary_entries(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
1573
+ >>> thread = api.list_diary_entries(scope, code, effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
1597
1574
  >>> result = thread.get()
1598
1575
 
1599
1576
  :param scope: The scope of the Abor. (required)
@@ -1604,12 +1581,14 @@ class AborApi:
1604
1581
  :type effective_at: str
1605
1582
  :param as_at: The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified.
1606
1583
  :type as_at: datetime
1607
- :param page: The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.
1584
+ :param page: The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1608
1585
  :type page: str
1609
1586
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1610
1587
  :type limit: int
1611
1588
  :param filter: Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1612
1589
  :type filter: str
1590
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1591
+ :type sort_by: List[str]
1613
1592
  :param property_keys: A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.
1614
1593
  :type property_keys: List[str]
1615
1594
  :param async_req: Whether to execute the request asynchronously.
@@ -1629,17 +1608,17 @@ class AborApi:
1629
1608
  raise ValueError(message)
1630
1609
  if async_req is not None:
1631
1610
  kwargs['async_req'] = async_req
1632
- return self.list_diary_entries_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, **kwargs) # noqa: E501
1611
+ return self.list_diary_entries_with_http_info(scope, code, effective_at, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
1633
1612
 
1634
1613
  @validate_arguments
1635
- def list_diary_entries_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1614
+ def list_diary_entries_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. 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 DiaryEntry. Defaults to returning the latest version of each DiaryEntry 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 diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1636
1615
  """[EXPERIMENTAL] ListDiaryEntries: List diary entries. # noqa: E501
1637
1616
 
1638
1617
  List all the diary entries matching particular criteria. # noqa: E501
1639
1618
  This method makes a synchronous HTTP request by default. To make an
1640
1619
  asynchronous HTTP request, please pass async_req=True
1641
1620
 
1642
- >>> thread = api.list_diary_entries_with_http_info(scope, code, effective_at, as_at, page, limit, filter, property_keys, async_req=True)
1621
+ >>> thread = api.list_diary_entries_with_http_info(scope, code, effective_at, as_at, page, limit, filter, sort_by, property_keys, async_req=True)
1643
1622
  >>> result = thread.get()
1644
1623
 
1645
1624
  :param scope: The scope of the Abor. (required)
@@ -1650,12 +1629,14 @@ class AborApi:
1650
1629
  :type effective_at: str
1651
1630
  :param as_at: The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified.
1652
1631
  :type as_at: datetime
1653
- :param page: The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. Also, if set, a start value cannot be provided.
1632
+ :param page: The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1654
1633
  :type page: str
1655
1634
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1656
1635
  :type limit: int
1657
1636
  :param filter: Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq 'PeriodBoundary'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1658
1637
  :type filter: str
1638
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1639
+ :type sort_by: List[str]
1659
1640
  :param property_keys: A list of property keys from the 'DiaryEntry' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example 'DiaryEntry/Report/Id'.
1660
1641
  :type property_keys: List[str]
1661
1642
  :param async_req: Whether to execute the request asynchronously.
@@ -1693,6 +1674,7 @@ class AborApi:
1693
1674
  'page',
1694
1675
  'limit',
1695
1676
  'filter',
1677
+ 'sort_by',
1696
1678
  'property_keys'
1697
1679
  ]
1698
1680
  _all_params.extend(
@@ -1748,6 +1730,10 @@ class AborApi:
1748
1730
  if _params.get('filter') is not None: # noqa: E501
1749
1731
  _query_params.append(('filter', _params['filter']))
1750
1732
 
1733
+ if _params.get('sort_by') is not None: # noqa: E501
1734
+ _query_params.append(('sortBy', _params['sort_by']))
1735
+ _collection_formats['sortBy'] = 'multi'
1736
+
1751
1737
  if _params.get('property_keys') is not None: # noqa: E501
1752
1738
  _query_params.append(('propertyKeys', _params['property_keys']))
1753
1739
  _collection_formats['propertyKeys'] = 'multi'
@@ -1788,6 +1774,354 @@ class AborApi:
1788
1774
  collection_formats=_collection_formats,
1789
1775
  _request_auth=_params.get('_request_auth'))
1790
1776
 
1777
+ @overload
1778
+ async def lock_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], lock_period_diary_entry_request : Annotated[Optional[LockPeriodDiaryEntryRequest], Field(description="The request body, detailing lock details")] = None, **kwargs) -> DiaryEntry: # noqa: E501
1779
+ ...
1780
+
1781
+ @overload
1782
+ def lock_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], lock_period_diary_entry_request : Annotated[Optional[LockPeriodDiaryEntryRequest], Field(description="The request body, detailing lock details")] = None, async_req: Optional[bool]=True, **kwargs) -> DiaryEntry: # noqa: E501
1783
+ ...
1784
+
1785
+ @validate_arguments
1786
+ def lock_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], lock_period_diary_entry_request : Annotated[Optional[LockPeriodDiaryEntryRequest], Field(description="The request body, detailing lock details")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DiaryEntry, Awaitable[DiaryEntry]]: # noqa: E501
1787
+ """[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. # noqa: E501
1788
+
1789
+ Locks the specified or last locked period for the given Abor. # noqa: E501
1790
+ This method makes a synchronous HTTP request by default. To make an
1791
+ asynchronous HTTP request, please pass async_req=True
1792
+
1793
+ >>> thread = api.lock_period(scope, code, lock_period_diary_entry_request, async_req=True)
1794
+ >>> result = thread.get()
1795
+
1796
+ :param scope: The scope of the Abor. (required)
1797
+ :type scope: str
1798
+ :param code: The code of the Abor. (required)
1799
+ :type code: str
1800
+ :param lock_period_diary_entry_request: The request body, detailing lock details
1801
+ :type lock_period_diary_entry_request: LockPeriodDiaryEntryRequest
1802
+ :param async_req: Whether to execute the request asynchronously.
1803
+ :type async_req: bool, optional
1804
+ :param _request_timeout: timeout setting for this request.
1805
+ If one number provided, it will be total request
1806
+ timeout. It can also be a pair (tuple) of
1807
+ (connection, read) timeouts.
1808
+ :return: Returns the result object.
1809
+ If the method is called asynchronously,
1810
+ returns the request thread.
1811
+ :rtype: DiaryEntry
1812
+ """
1813
+ kwargs['_return_http_data_only'] = True
1814
+ if '_preload_content' in kwargs:
1815
+ message = "Error! Please call the lock_period_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
1816
+ raise ValueError(message)
1817
+ if async_req is not None:
1818
+ kwargs['async_req'] = async_req
1819
+ return self.lock_period_with_http_info(scope, code, lock_period_diary_entry_request, **kwargs) # noqa: E501
1820
+
1821
+ @validate_arguments
1822
+ def lock_period_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor.")], lock_period_diary_entry_request : Annotated[Optional[LockPeriodDiaryEntryRequest], Field(description="The request body, detailing lock details")] = None, **kwargs) -> ApiResponse: # noqa: E501
1823
+ """[EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. # noqa: E501
1824
+
1825
+ Locks the specified or last locked period for the given Abor. # noqa: E501
1826
+ This method makes a synchronous HTTP request by default. To make an
1827
+ asynchronous HTTP request, please pass async_req=True
1828
+
1829
+ >>> thread = api.lock_period_with_http_info(scope, code, lock_period_diary_entry_request, async_req=True)
1830
+ >>> result = thread.get()
1831
+
1832
+ :param scope: The scope of the Abor. (required)
1833
+ :type scope: str
1834
+ :param code: The code of the Abor. (required)
1835
+ :type code: str
1836
+ :param lock_period_diary_entry_request: The request body, detailing lock details
1837
+ :type lock_period_diary_entry_request: LockPeriodDiaryEntryRequest
1838
+ :param async_req: Whether to execute the request asynchronously.
1839
+ :type async_req: bool, optional
1840
+ :param _preload_content: if False, the ApiResponse.data will
1841
+ be set to none and raw_data will store the
1842
+ HTTP response body without reading/decoding.
1843
+ Default is True.
1844
+ :type _preload_content: bool, optional
1845
+ :param _return_http_data_only: response data instead of ApiResponse
1846
+ object with status code, headers, etc
1847
+ :type _return_http_data_only: bool, optional
1848
+ :param _request_timeout: timeout setting for this request. If one
1849
+ number provided, it will be total request
1850
+ timeout. It can also be a pair (tuple) of
1851
+ (connection, read) timeouts.
1852
+ :param _request_auth: set to override the auth_settings for an a single
1853
+ request; this effectively ignores the authentication
1854
+ in the spec for a single request.
1855
+ :type _request_auth: dict, optional
1856
+ :type _content_type: string, optional: force content-type for the request
1857
+ :return: Returns the result object.
1858
+ If the method is called asynchronously,
1859
+ returns the request thread.
1860
+ :rtype: tuple(DiaryEntry, status_code(int), headers(HTTPHeaderDict))
1861
+ """
1862
+
1863
+ _params = locals()
1864
+
1865
+ _all_params = [
1866
+ 'scope',
1867
+ 'code',
1868
+ 'lock_period_diary_entry_request'
1869
+ ]
1870
+ _all_params.extend(
1871
+ [
1872
+ 'async_req',
1873
+ '_return_http_data_only',
1874
+ '_preload_content',
1875
+ '_request_timeout',
1876
+ '_request_auth',
1877
+ '_content_type',
1878
+ '_headers'
1879
+ ]
1880
+ )
1881
+
1882
+ # validate the arguments
1883
+ for _key, _val in _params['kwargs'].items():
1884
+ if _key not in _all_params:
1885
+ raise ApiTypeError(
1886
+ "Got an unexpected keyword argument '%s'"
1887
+ " to method lock_period" % _key
1888
+ )
1889
+ _params[_key] = _val
1890
+ del _params['kwargs']
1891
+
1892
+ _collection_formats = {}
1893
+
1894
+ # process the path parameters
1895
+ _path_params = {}
1896
+ if _params['scope']:
1897
+ _path_params['scope'] = _params['scope']
1898
+
1899
+ if _params['code']:
1900
+ _path_params['code'] = _params['code']
1901
+
1902
+
1903
+ # process the query parameters
1904
+ _query_params = []
1905
+ # process the header parameters
1906
+ _header_params = dict(_params.get('_headers', {}))
1907
+ # process the form parameters
1908
+ _form_params = []
1909
+ _files = {}
1910
+ # process the body parameter
1911
+ _body_params = None
1912
+ if _params['lock_period_diary_entry_request'] is not None:
1913
+ _body_params = _params['lock_period_diary_entry_request']
1914
+
1915
+ # set the HTTP header `Accept`
1916
+ _header_params['Accept'] = self.api_client.select_header_accept(
1917
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1918
+
1919
+ # set the HTTP header `Content-Type`
1920
+ _content_types_list = _params.get('_content_type',
1921
+ self.api_client.select_header_content_type(
1922
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
1923
+ if _content_types_list:
1924
+ _header_params['Content-Type'] = _content_types_list
1925
+
1926
+ # authentication setting
1927
+ _auth_settings = ['oauth2'] # noqa: E501
1928
+
1929
+ _response_types_map = {
1930
+ '200': "DiaryEntry",
1931
+ '400': "LusidValidationProblemDetails",
1932
+ }
1933
+
1934
+ return self.api_client.call_api(
1935
+ '/api/abor/{scope}/{code}/accountingdiary/$lockperiod', 'POST',
1936
+ _path_params,
1937
+ _query_params,
1938
+ _header_params,
1939
+ body=_body_params,
1940
+ post_params=_form_params,
1941
+ files=_files,
1942
+ response_types_map=_response_types_map,
1943
+ auth_settings=_auth_settings,
1944
+ async_req=_params.get('async_req'),
1945
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1946
+ _preload_content=_params.get('_preload_content', True),
1947
+ _request_timeout=_params.get('_request_timeout'),
1948
+ collection_formats=_collection_formats,
1949
+ _request_auth=_params.get('_request_auth'))
1950
+
1951
+ @overload
1952
+ async def re_open_periods(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], re_open_period_diary_entry_request : Annotated[Optional[ReOpenPeriodDiaryEntryRequest], Field(description="The request body, detailing re open details")] = None, **kwargs) -> PeriodDiaryEntriesReopenedResponse: # noqa: E501
1953
+ ...
1954
+
1955
+ @overload
1956
+ def re_open_periods(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], re_open_period_diary_entry_request : Annotated[Optional[ReOpenPeriodDiaryEntryRequest], Field(description="The request body, detailing re open details")] = None, async_req: Optional[bool]=True, **kwargs) -> PeriodDiaryEntriesReopenedResponse: # noqa: E501
1957
+ ...
1958
+
1959
+ @validate_arguments
1960
+ def re_open_periods(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], re_open_period_diary_entry_request : Annotated[Optional[ReOpenPeriodDiaryEntryRequest], Field(description="The request body, detailing re open details")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PeriodDiaryEntriesReopenedResponse, Awaitable[PeriodDiaryEntriesReopenedResponse]]: # noqa: E501
1961
+ """[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. # noqa: E501
1962
+
1963
+ Reopens one or more periods. # noqa: E501
1964
+ This method makes a synchronous HTTP request by default. To make an
1965
+ asynchronous HTTP request, please pass async_req=True
1966
+
1967
+ >>> thread = api.re_open_periods(scope, code, re_open_period_diary_entry_request, async_req=True)
1968
+ >>> result = thread.get()
1969
+
1970
+ :param scope: The scope of the Abor to be deleted. (required)
1971
+ :type scope: str
1972
+ :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
1973
+ :type code: str
1974
+ :param re_open_period_diary_entry_request: The request body, detailing re open details
1975
+ :type re_open_period_diary_entry_request: ReOpenPeriodDiaryEntryRequest
1976
+ :param async_req: Whether to execute the request asynchronously.
1977
+ :type async_req: bool, optional
1978
+ :param _request_timeout: timeout setting for this request.
1979
+ If one number provided, it will be total request
1980
+ timeout. It can also be a pair (tuple) of
1981
+ (connection, read) timeouts.
1982
+ :return: Returns the result object.
1983
+ If the method is called asynchronously,
1984
+ returns the request thread.
1985
+ :rtype: PeriodDiaryEntriesReopenedResponse
1986
+ """
1987
+ kwargs['_return_http_data_only'] = True
1988
+ if '_preload_content' in kwargs:
1989
+ message = "Error! Please call the re_open_periods_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
1990
+ raise ValueError(message)
1991
+ if async_req is not None:
1992
+ kwargs['async_req'] = async_req
1993
+ return self.re_open_periods_with_http_info(scope, code, re_open_period_diary_entry_request, **kwargs) # noqa: E501
1994
+
1995
+ @validate_arguments
1996
+ def re_open_periods_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to be deleted.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor.")], re_open_period_diary_entry_request : Annotated[Optional[ReOpenPeriodDiaryEntryRequest], Field(description="The request body, detailing re open details")] = None, **kwargs) -> ApiResponse: # noqa: E501
1997
+ """[EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. # noqa: E501
1998
+
1999
+ Reopens one or more periods. # noqa: E501
2000
+ This method makes a synchronous HTTP request by default. To make an
2001
+ asynchronous HTTP request, please pass async_req=True
2002
+
2003
+ >>> thread = api.re_open_periods_with_http_info(scope, code, re_open_period_diary_entry_request, async_req=True)
2004
+ >>> result = thread.get()
2005
+
2006
+ :param scope: The scope of the Abor to be deleted. (required)
2007
+ :type scope: str
2008
+ :param code: The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. (required)
2009
+ :type code: str
2010
+ :param re_open_period_diary_entry_request: The request body, detailing re open details
2011
+ :type re_open_period_diary_entry_request: ReOpenPeriodDiaryEntryRequest
2012
+ :param async_req: Whether to execute the request asynchronously.
2013
+ :type async_req: bool, optional
2014
+ :param _preload_content: if False, the ApiResponse.data will
2015
+ be set to none and raw_data will store the
2016
+ HTTP response body without reading/decoding.
2017
+ Default is True.
2018
+ :type _preload_content: bool, optional
2019
+ :param _return_http_data_only: response data instead of ApiResponse
2020
+ object with status code, headers, etc
2021
+ :type _return_http_data_only: bool, optional
2022
+ :param _request_timeout: timeout setting for this request. If one
2023
+ number provided, it will be total request
2024
+ timeout. It can also be a pair (tuple) of
2025
+ (connection, read) timeouts.
2026
+ :param _request_auth: set to override the auth_settings for an a single
2027
+ request; this effectively ignores the authentication
2028
+ in the spec for a single request.
2029
+ :type _request_auth: dict, optional
2030
+ :type _content_type: string, optional: force content-type for the request
2031
+ :return: Returns the result object.
2032
+ If the method is called asynchronously,
2033
+ returns the request thread.
2034
+ :rtype: tuple(PeriodDiaryEntriesReopenedResponse, status_code(int), headers(HTTPHeaderDict))
2035
+ """
2036
+
2037
+ _params = locals()
2038
+
2039
+ _all_params = [
2040
+ 'scope',
2041
+ 'code',
2042
+ 're_open_period_diary_entry_request'
2043
+ ]
2044
+ _all_params.extend(
2045
+ [
2046
+ 'async_req',
2047
+ '_return_http_data_only',
2048
+ '_preload_content',
2049
+ '_request_timeout',
2050
+ '_request_auth',
2051
+ '_content_type',
2052
+ '_headers'
2053
+ ]
2054
+ )
2055
+
2056
+ # validate the arguments
2057
+ for _key, _val in _params['kwargs'].items():
2058
+ if _key not in _all_params:
2059
+ raise ApiTypeError(
2060
+ "Got an unexpected keyword argument '%s'"
2061
+ " to method re_open_periods" % _key
2062
+ )
2063
+ _params[_key] = _val
2064
+ del _params['kwargs']
2065
+
2066
+ _collection_formats = {}
2067
+
2068
+ # process the path parameters
2069
+ _path_params = {}
2070
+ if _params['scope']:
2071
+ _path_params['scope'] = _params['scope']
2072
+
2073
+ if _params['code']:
2074
+ _path_params['code'] = _params['code']
2075
+
2076
+
2077
+ # process the query parameters
2078
+ _query_params = []
2079
+ # process the header parameters
2080
+ _header_params = dict(_params.get('_headers', {}))
2081
+ # process the form parameters
2082
+ _form_params = []
2083
+ _files = {}
2084
+ # process the body parameter
2085
+ _body_params = None
2086
+ if _params['re_open_period_diary_entry_request'] is not None:
2087
+ _body_params = _params['re_open_period_diary_entry_request']
2088
+
2089
+ # set the HTTP header `Accept`
2090
+ _header_params['Accept'] = self.api_client.select_header_accept(
2091
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
2092
+
2093
+ # set the HTTP header `Content-Type`
2094
+ _content_types_list = _params.get('_content_type',
2095
+ self.api_client.select_header_content_type(
2096
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
2097
+ if _content_types_list:
2098
+ _header_params['Content-Type'] = _content_types_list
2099
+
2100
+ # authentication setting
2101
+ _auth_settings = ['oauth2'] # noqa: E501
2102
+
2103
+ _response_types_map = {
2104
+ '200': "PeriodDiaryEntriesReopenedResponse",
2105
+ '400': "LusidValidationProblemDetails",
2106
+ }
2107
+
2108
+ return self.api_client.call_api(
2109
+ '/api/abor/{scope}/{code}/accountingdiary/$reopenperiods', 'POST',
2110
+ _path_params,
2111
+ _query_params,
2112
+ _header_params,
2113
+ body=_body_params,
2114
+ post_params=_form_params,
2115
+ files=_files,
2116
+ response_types_map=_response_types_map,
2117
+ auth_settings=_auth_settings,
2118
+ async_req=_params.get('async_req'),
2119
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
2120
+ _preload_content=_params.get('_preload_content', True),
2121
+ _request_timeout=_params.get('_request_timeout'),
2122
+ collection_formats=_collection_formats,
2123
+ _request_auth=_params.get('_request_auth'))
2124
+
1791
2125
  @overload
1792
2126
  async def upsert_abor_properties(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Abor to update or insert the properties onto.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor.")], request_body : Annotated[Optional[Dict[str, ModelProperty]], Field(description="The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"Abor/Manager/Id\".")] = None, **kwargs) -> AborProperties: # noqa: E501
1793
2127
  ...