lusid-sdk 2.1.910__py3-none-any.whl → 2.1.912__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. lusid/api/abor_api.py +66 -66
  2. lusid/api/abor_configuration_api.py +32 -32
  3. lusid/api/address_key_definition_api.py +10 -10
  4. lusid/api/aggregated_returns_api.py +12 -12
  5. lusid/api/aggregation_api.py +10 -10
  6. lusid/api/allocations_api.py +24 -24
  7. lusid/api/amortisation_rule_sets_api.py +24 -24
  8. lusid/api/application_metadata_api.py +6 -6
  9. lusid/api/blocks_api.py +18 -18
  10. lusid/api/calendars_api.py +34 -34
  11. lusid/api/chart_of_accounts_api.py +122 -122
  12. lusid/api/check_definitions_api.py +38 -38
  13. lusid/api/complex_market_data_api.py +36 -36
  14. lusid/api/compliance_api.py +34 -34
  15. lusid/api/configuration_recipe_api.py +20 -20
  16. lusid/api/conventions_api.py +18 -18
  17. lusid/api/corporate_action_sources_api.py +32 -32
  18. lusid/api/counterparties_api.py +12 -12
  19. lusid/api/custom_data_models_api.py +16 -16
  20. lusid/api/custom_entities_api.py +40 -40
  21. lusid/api/custom_entity_definitions_api.py +10 -10
  22. lusid/api/custom_entity_types_api.py +10 -10
  23. lusid/api/cut_label_definitions_api.py +8 -8
  24. lusid/api/data_types_api.py +34 -34
  25. lusid/api/derived_transaction_portfolios_api.py +6 -6
  26. lusid/api/entities_api.py +20 -20
  27. lusid/api/executions_api.py +18 -18
  28. lusid/api/fee_types_api.py +8 -8
  29. lusid/api/fund_configuration_api.py +38 -38
  30. lusid/api/funds_api.py +126 -126
  31. lusid/api/group_reconciliations_api.py +84 -84
  32. lusid/api/identifier_definitions_api.py +30 -30
  33. lusid/api/instrument_event_types_api.py +40 -40
  34. lusid/api/instrument_events_api.py +34 -34
  35. lusid/api/instruments_api.py +138 -138
  36. lusid/api/investment_accounts_api.py +24 -24
  37. lusid/api/investor_records_api.py +26 -26
  38. lusid/api/legacy_compliance_api.py +46 -46
  39. lusid/api/legal_entities_api.py +114 -114
  40. lusid/api/order_graph_api.py +6 -6
  41. lusid/api/order_instructions_api.py +18 -18
  42. lusid/api/order_management_api.py +28 -28
  43. lusid/api/orders_api.py +18 -18
  44. lusid/api/packages_api.py +18 -18
  45. lusid/api/participations_api.py +18 -18
  46. lusid/api/persons_api.py +114 -114
  47. lusid/api/placements_api.py +18 -18
  48. lusid/api/portfolio_groups_api.py +156 -156
  49. lusid/api/portfolios_api.py +128 -128
  50. lusid/api/property_definitions_api.py +74 -74
  51. lusid/api/queryable_keys_api.py +6 -6
  52. lusid/api/quotes_api.py +36 -36
  53. lusid/api/reconciliations_api.py +42 -42
  54. lusid/api/reference_lists_api.py +8 -8
  55. lusid/api/reference_portfolio_api.py +30 -30
  56. lusid/api/relation_definitions_api.py +14 -14
  57. lusid/api/relationship_definitions_api.py +32 -32
  58. lusid/api/scopes_api.py +12 -12
  59. lusid/api/scripted_translation_api.py +22 -22
  60. lusid/api/search_api.py +28 -28
  61. lusid/api/sequences_api.py +20 -20
  62. lusid/api/staged_modifications_api.py +20 -20
  63. lusid/api/staging_rule_set_api.py +18 -18
  64. lusid/api/structured_result_data_api.py +38 -38
  65. lusid/api/system_configuration_api.py +20 -20
  66. lusid/api/tax_rule_sets_api.py +34 -34
  67. lusid/api/timelines_api.py +68 -68
  68. lusid/api/transaction_configuration_api.py +18 -18
  69. lusid/api/transaction_fees_api.py +42 -42
  70. lusid/api/transaction_portfolios_api.py +450 -450
  71. lusid/api/transfer_agency_api.py +2 -2
  72. lusid/api/translation_api.py +4 -4
  73. lusid/api/workspace_api.py +24 -24
  74. lusid/configuration.py +1 -1
  75. lusid/models/access_metadata_value.py +1 -1
  76. lusid/models/accumulation_event.py +1 -1
  77. lusid/models/additional_payment.py +1 -1
  78. lusid/models/address_definition.py +2 -2
  79. lusid/models/adjust_global_commitment_event.py +2 -2
  80. lusid/models/adjust_holding_for_date_request.py +1 -1
  81. lusid/models/adjust_holding_request.py +1 -1
  82. lusid/models/aggregate_spec.py +1 -1
  83. lusid/models/aggregation_context.py +1 -1
  84. lusid/models/aggregation_options.py +3 -3
  85. lusid/models/allocation.py +1 -1
  86. lusid/models/amortisation_event.py +2 -2
  87. lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
  88. lusid/models/asset_leg.py +2 -2
  89. lusid/models/basket.py +1 -1
  90. lusid/models/block.py +1 -1
  91. lusid/models/bond.py +5 -5
  92. lusid/models/bond_conversion_entry.py +3 -3
  93. lusid/models/bond_conversion_schedule.py +5 -5
  94. lusid/models/bond_coupon_event.py +1 -1
  95. lusid/models/bond_principal_event.py +1 -1
  96. lusid/models/bucketed_cash_flow_response.py +3 -3
  97. lusid/models/cancel_single_holding_adjustment_request.py +1 -1
  98. lusid/models/cap_floor.py +2 -2
  99. lusid/models/cash_and_security_offer_election.py +1 -1
  100. lusid/models/cash_dependency.py +2 -2
  101. lusid/models/cash_flow_event.py +1 -1
  102. lusid/models/cash_flow_lineage.py +2 -2
  103. lusid/models/cash_offer_election.py +1 -1
  104. lusid/models/cds_flow_conventions.py +5 -5
  105. lusid/models/cds_index.py +4 -4
  106. lusid/models/cds_protection_detail_specification.py +3 -3
  107. lusid/models/change_item.py +1 -1
  108. lusid/models/close_event.py +1 -1
  109. lusid/models/collateral.py +2 -2
  110. lusid/models/complex_bond.py +4 -4
  111. lusid/models/complex_market_data.py +1 -1
  112. lusid/models/complex_market_data_id.py +1 -1
  113. lusid/models/compounding.py +6 -6
  114. lusid/models/configuration_recipe.py +1 -1
  115. lusid/models/constant_volatility_surface.py +2 -2
  116. lusid/models/constituents_adjustment_header.py +1 -1
  117. lusid/models/contract_for_difference.py +6 -6
  118. lusid/models/conversion_event.py +9 -9
  119. lusid/models/corporate_action_transition_component_request.py +1 -1
  120. lusid/models/counterparty_agreement.py +1 -1
  121. lusid/models/counterparty_risk_information.py +1 -1
  122. lusid/models/counterparty_signatory.py +1 -1
  123. lusid/models/credit_default_swap.py +4 -4
  124. lusid/models/credit_premium_cash_flow_event.py +1 -1
  125. lusid/models/credit_rating.py +1 -1
  126. lusid/models/credit_spread_curve_data.py +3 -3
  127. lusid/models/credit_support_annex.py +6 -6
  128. lusid/models/curve_options.py +2 -2
  129. lusid/models/data_definition.py +3 -3
  130. lusid/models/data_map_key.py +1 -1
  131. lusid/models/data_mapping.py +1 -1
  132. lusid/models/dependency_source_filter.py +6 -6
  133. lusid/models/dialect.py +1 -1
  134. lusid/models/dialect_schema.py +1 -1
  135. lusid/models/discounting_dependency.py +2 -2
  136. lusid/models/dividend_option_event.py +1 -1
  137. lusid/models/dividend_reinvestment_event.py +1 -1
  138. lusid/models/early_redemption_election.py +1 -1
  139. lusid/models/early_redemption_event.py +2 -2
  140. lusid/models/economic_dependency.py +1 -1
  141. lusid/models/equity.py +1 -1
  142. lusid/models/equity_curve_by_prices_data.py +1 -1
  143. lusid/models/equity_curve_dependency.py +2 -2
  144. lusid/models/equity_model_options.py +1 -1
  145. lusid/models/equity_option.py +7 -7
  146. lusid/models/equity_swap.py +6 -6
  147. lusid/models/equity_vol_dependency.py +2 -2
  148. lusid/models/event_date_range.py +1 -1
  149. lusid/models/ex_dividend_configuration.py +3 -3
  150. lusid/models/exchange_traded_option.py +1 -1
  151. lusid/models/exchange_traded_option_contract_details.py +5 -5
  152. lusid/models/execution.py +1 -1
  153. lusid/models/exercise_event.py +1 -1
  154. lusid/models/exotic_instrument.py +1 -1
  155. lusid/models/expiry_event.py +1 -1
  156. lusid/models/fixed_leg.py +1 -1
  157. lusid/models/fixed_leg_all_of_overrides.py +1 -1
  158. lusid/models/fixed_schedule.py +3 -3
  159. lusid/models/flexible_deposit.py +2 -2
  160. lusid/models/flexible_loan.py +2 -2
  161. lusid/models/flexible_repo.py +10 -10
  162. lusid/models/flexible_repo_cash_flow_event.py +2 -2
  163. lusid/models/flexible_repo_collateral_event.py +2 -2
  164. lusid/models/flexible_repo_interest_payment_event.py +2 -2
  165. lusid/models/flexible_repo_partial_closure_event.py +5 -5
  166. lusid/models/float_schedule.py +5 -5
  167. lusid/models/floating_leg.py +1 -1
  168. lusid/models/flow_convention_name.py +1 -1
  169. lusid/models/flow_conventions.py +9 -9
  170. lusid/models/forward_rate_agreement.py +1 -1
  171. lusid/models/fund_share_class.py +4 -4
  172. lusid/models/fund_valuation_request.py +4 -4
  173. lusid/models/fund_valuation_schedule.py +4 -4
  174. lusid/models/funding_leg.py +3 -3
  175. lusid/models/future.py +4 -4
  176. lusid/models/future_expiry_event.py +1 -1
  177. lusid/models/future_mark_to_market_event.py +1 -1
  178. lusid/models/futures_contract_details.py +5 -5
  179. lusid/models/fx_conventions.py +1 -1
  180. lusid/models/fx_dependency.py +1 -1
  181. lusid/models/fx_forward.py +6 -6
  182. lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
  183. lusid/models/fx_forward_model_options.py +1 -1
  184. lusid/models/fx_forward_settlement_event.py +6 -6
  185. lusid/models/fx_forward_tenor_curve_data.py +2 -2
  186. lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
  187. lusid/models/fx_forwards_dependency.py +3 -3
  188. lusid/models/fx_linked_notional_schedule.py +1 -1
  189. lusid/models/fx_option.py +8 -8
  190. lusid/models/fx_rate_schedule.py +1 -1
  191. lusid/models/fx_swap.py +2 -2
  192. lusid/models/fx_tenor_convention.py +1 -1
  193. lusid/models/fx_vol_dependency.py +2 -2
  194. lusid/models/get_reference_portfolio_constituents_response.py +1 -1
  195. lusid/models/group_of_market_data_key_rules.py +2 -2
  196. lusid/models/holding_context.py +1 -1
  197. lusid/models/holding_pricing_info.py +2 -2
  198. lusid/models/index_convention.py +4 -4
  199. lusid/models/index_projection_dependency.py +2 -2
  200. lusid/models/industry_classifier.py +1 -1
  201. lusid/models/inflation_index_conventions.py +4 -4
  202. lusid/models/inflation_leg.py +5 -5
  203. lusid/models/inflation_linked_bond.py +6 -6
  204. lusid/models/inflation_swap.py +3 -3
  205. lusid/models/informational_event.py +3 -3
  206. lusid/models/inline_valuation_request.py +6 -6
  207. lusid/models/inline_valuations_reconciliation_request.py +1 -1
  208. lusid/models/instrument_capabilities.py +1 -1
  209. lusid/models/instrument_definition_format.py +2 -2
  210. lusid/models/instrument_event.py +1 -1
  211. lusid/models/instrument_leg.py +1 -1
  212. lusid/models/interest_rate_swap.py +4 -4
  213. lusid/models/interest_rate_swaption.py +2 -2
  214. lusid/models/ir_vol_dependency.py +2 -2
  215. lusid/models/lapse_election.py +1 -1
  216. lusid/models/leg_definition.py +8 -8
  217. lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
  218. lusid/models/loan_facility.py +3 -3
  219. lusid/models/loan_facility_contract_rollover_event.py +2 -2
  220. lusid/models/loan_interest_repayment_event.py +2 -2
  221. lusid/models/loan_principal_repayment_event.py +3 -3
  222. lusid/models/lusid_instrument.py +1 -1
  223. lusid/models/lusid_trade_ticket.py +1 -1
  224. lusid/models/mark_to_market_conventions.py +1 -1
  225. lusid/models/market_context.py +4 -4
  226. lusid/models/market_context_suppliers.py +1 -1
  227. lusid/models/market_data_key_rule.py +7 -7
  228. lusid/models/market_data_options.py +1 -1
  229. lusid/models/market_data_specific_rule.py +6 -6
  230. lusid/models/market_data_type.py +1 -1
  231. lusid/models/market_options.py +1 -1
  232. lusid/models/market_quote.py +1 -1
  233. lusid/models/mastered_instrument.py +1 -1
  234. lusid/models/match_criterion.py +1 -1
  235. lusid/models/maturity_event.py +1 -1
  236. lusid/models/mbs_coupon_event.py +1 -1
  237. lusid/models/mbs_interest_deferral_event.py +1 -1
  238. lusid/models/mbs_interest_shortfall_event.py +1 -1
  239. lusid/models/mbs_principal_event.py +1 -1
  240. lusid/models/mbs_principal_write_off_event.py +1 -1
  241. lusid/models/model_options.py +1 -1
  242. lusid/models/model_selection.py +1 -1
  243. lusid/models/opaque_dependency.py +1 -1
  244. lusid/models/opaque_market_data.py +3 -3
  245. lusid/models/option_entry.py +1 -1
  246. lusid/models/option_exercise_cash_event.py +3 -3
  247. lusid/models/option_exercise_election.py +1 -1
  248. lusid/models/option_exercise_physical_event.py +3 -3
  249. lusid/models/optionality_schedule.py +2 -2
  250. lusid/models/order_flow_configuration.py +1 -1
  251. lusid/models/partial_closure_constituent.py +3 -3
  252. lusid/models/portfolio_holding.py +6 -2
  253. lusid/models/portfolio_result_data_key_rule.py +1 -1
  254. lusid/models/pre_trade_configuration.py +1 -1
  255. lusid/models/pricing_context.py +3 -3
  256. lusid/models/pricing_options.py +9 -9
  257. lusid/models/property_domain.py +1 -1
  258. lusid/models/property_reference_data_value.py +1 -1
  259. lusid/models/quote_dependency.py +1 -1
  260. lusid/models/quote_series_id.py +1 -1
  261. lusid/models/raw_vendor_event.py +1 -1
  262. lusid/models/recipe_value.py +1 -1
  263. lusid/models/reconcile_date_time_rule.py +1 -1
  264. lusid/models/reconcile_numeric_rule.py +1 -1
  265. lusid/models/reconcile_string_rule.py +1 -1
  266. lusid/models/reconciled_transaction.py +2 -2
  267. lusid/models/reconciliation_line.py +1 -1
  268. lusid/models/reconciliation_request.py +3 -3
  269. lusid/models/reconciliation_rule.py +1 -1
  270. lusid/models/relative_date_offset.py +2 -2
  271. lusid/models/repo.py +8 -8
  272. lusid/models/repo_cash_flow_event.py +4 -4
  273. lusid/models/repo_partial_closure_event.py +5 -5
  274. lusid/models/repurchase_offer_event.py +4 -4
  275. lusid/models/reset_event.py +1 -1
  276. lusid/models/result_data_key_rule.py +6 -4
  277. lusid/models/result_data_schema.py +1 -1
  278. lusid/models/result_key_rule.py +1 -1
  279. lusid/models/result_value.py +1 -1
  280. lusid/models/result_value0_d.py +1 -1
  281. lusid/models/result_value_date_time_offset.py +1 -1
  282. lusid/models/result_value_decimal.py +1 -1
  283. lusid/models/result_value_int.py +1 -1
  284. lusid/models/return_zero_pv_options.py +1 -1
  285. lusid/models/rounding_convention.py +4 -4
  286. lusid/models/schedule.py +1 -1
  287. lusid/models/scrip_dividend_event.py +1 -1
  288. lusid/models/security_election.py +2 -2
  289. lusid/models/security_offer_election.py +1 -1
  290. lusid/models/settlement_schedule.py +20 -2
  291. lusid/models/side_configuration_data.py +1 -1
  292. lusid/models/side_configuration_data_request.py +1 -1
  293. lusid/models/simple_cash_flow_loan.py +2 -2
  294. lusid/models/simple_instrument.py +2 -2
  295. lusid/models/simple_rounding_convention.py +2 -2
  296. lusid/models/step_schedule.py +3 -3
  297. lusid/models/stock_dividend_event.py +1 -1
  298. lusid/models/structured_result_data.py +1 -1
  299. lusid/models/swap_cash_flow_event.py +1 -1
  300. lusid/models/swap_principal_event.py +1 -1
  301. lusid/models/tender_offer_election.py +1 -1
  302. lusid/models/term_deposit.py +1 -1
  303. lusid/models/term_deposit_interest_event.py +1 -1
  304. lusid/models/term_deposit_principal_event.py +1 -1
  305. lusid/models/time_zone_conventions.py +1 -1
  306. lusid/models/total_return_swap.py +3 -3
  307. lusid/models/trading_conventions.py +3 -3
  308. lusid/models/transaction_reconciliation_request_v2.py +3 -3
  309. lusid/models/translate_entities_inlined_request.py +1 -1
  310. lusid/models/translate_entities_request.py +1 -1
  311. lusid/models/translate_instrument_definitions_request.py +1 -1
  312. lusid/models/translate_trade_ticket_request.py +1 -1
  313. lusid/models/translation_input.py +1 -1
  314. lusid/models/trigger_event.py +1 -1
  315. lusid/models/typed_resource_id.py +2 -2
  316. lusid/models/unmatched_holding_method.py +1 -1
  317. lusid/models/upsert_cds_flow_conventions_request.py +1 -1
  318. lusid/models/upsert_counterparty_agreement_request.py +1 -1
  319. lusid/models/upsert_flow_conventions_request.py +1 -1
  320. lusid/models/upsert_index_convention_request.py +1 -1
  321. lusid/models/upsert_quote_request.py +1 -1
  322. lusid/models/upsert_recipe_request.py +1 -1
  323. lusid/models/valuation_request.py +5 -5
  324. lusid/models/valuation_schedule.py +5 -5
  325. lusid/models/valuations_reconciliation_request.py +2 -2
  326. lusid/models/vendor_model_rule.py +3 -3
  327. lusid/models/virtual_document.py +1 -1
  328. lusid/models/weighted_instrument.py +2 -2
  329. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
  330. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
  331. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
  332. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
@@ -74,7 +74,7 @@ class TimelinesApi:
74
74
  def create_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
75
75
  """[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
76
76
 
77
- Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # noqa: E501
77
+ Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # noqa: E501
78
78
  This method makes a synchronous HTTP request by default. To make an
79
79
  asynchronous HTTP request, please pass async_req=True
80
80
 
@@ -109,7 +109,7 @@ class TimelinesApi:
109
109
  def create_closed_period_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, **kwargs) -> ApiResponse: # noqa: E501
110
110
  """[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
111
111
 
112
- Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # noqa: E501
112
+ Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # noqa: E501
113
113
  This method makes a synchronous HTTP request by default. To make an
114
114
  asynchronous HTTP request, please pass async_req=True
115
115
 
@@ -249,7 +249,7 @@ class TimelinesApi:
249
249
  def create_timeline(self, create_timeline_request : Annotated[Optional[CreateTimelineRequest], Field(description="The request containing the details of the Timeline")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Timeline, Awaitable[Timeline]]: # noqa: E501
250
250
  """[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501
251
251
 
252
- Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
252
+ Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
253
253
  This method makes a synchronous HTTP request by default. To make an
254
254
  asynchronous HTTP request, please pass async_req=True
255
255
 
@@ -280,7 +280,7 @@ class TimelinesApi:
280
280
  def create_timeline_with_http_info(self, create_timeline_request : Annotated[Optional[CreateTimelineRequest], Field(description="The request containing the details of the Timeline")] = None, **kwargs) -> ApiResponse: # noqa: E501
281
281
  """[EXPERIMENTAL] CreateTimeline: Create a Timeline # noqa: E501
282
282
 
283
- Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
283
+ Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
284
284
  This method makes a synchronous HTTP request by default. To make an
285
285
  asynchronous HTTP request, please pass async_req=True
286
286
 
@@ -397,18 +397,18 @@ class TimelinesApi:
397
397
 
398
398
 
399
399
  @overload
400
- async def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
400
+ async def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
401
401
  ...
402
402
 
403
403
  @overload
404
- def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
404
+ def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
405
405
  ...
406
406
 
407
407
  @validate_arguments
408
- def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
408
+ def delete_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
409
409
  """[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501
410
410
 
411
- The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
411
+ The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
412
412
  This method makes a synchronous HTTP request by default. To make an
413
413
  asynchronous HTTP request, please pass async_req=True
414
414
 
@@ -417,7 +417,7 @@ class TimelinesApi:
417
417
 
418
418
  :param scope: The scope of the specified Timeline. (required)
419
419
  :type scope: str
420
- :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
420
+ :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
421
421
  :type code: str
422
422
  :param async_req: Whether to execute the request asynchronously.
423
423
  :type async_req: bool, optional
@@ -438,10 +438,10 @@ class TimelinesApi:
438
438
  return self.delete_timeline_with_http_info(scope, code, **kwargs) # noqa: E501
439
439
 
440
440
  @validate_arguments
441
- def delete_timeline_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], **kwargs) -> ApiResponse: # noqa: E501
441
+ def delete_timeline_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], **kwargs) -> ApiResponse: # noqa: E501
442
442
  """[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline # noqa: E501
443
443
 
444
- The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
444
+ The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501
445
445
  This method makes a synchronous HTTP request by default. To make an
446
446
  asynchronous HTTP request, please pass async_req=True
447
447
 
@@ -450,7 +450,7 @@ class TimelinesApi:
450
450
 
451
451
  :param scope: The scope of the specified Timeline. (required)
452
452
  :type scope: str
453
- :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
453
+ :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
454
454
  :type code: str
455
455
  :param async_req: Whether to execute the request asynchronously.
456
456
  :type async_req: bool, optional
@@ -557,15 +557,15 @@ class TimelinesApi:
557
557
 
558
558
 
559
559
  @overload
560
- async def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
560
+ async def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
561
561
  ...
562
562
 
563
563
  @overload
564
- def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
564
+ def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
565
565
  ...
566
566
 
567
567
  @validate_arguments
568
- def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
568
+ def get_closed_period(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
569
569
  """[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501
570
570
 
571
571
  Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # noqa: E501
@@ -577,13 +577,13 @@ class TimelinesApi:
577
577
 
578
578
  :param scope: The scope of the Timeline. (required)
579
579
  :type scope: str
580
- :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
580
+ :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
581
581
  :type code: str
582
- :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
582
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
583
583
  :type closed_period_id: str
584
- :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
584
+ :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
585
585
  :type as_at: datetime
586
- :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
586
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
587
587
  :type property_keys: List[str]
588
588
  :param async_req: Whether to execute the request asynchronously.
589
589
  :type async_req: bool, optional
@@ -604,7 +604,7 @@ class TimelinesApi:
604
604
  return self.get_closed_period_with_http_info(scope, code, closed_period_id, as_at, property_keys, **kwargs) # noqa: E501
605
605
 
606
606
  @validate_arguments
607
- def get_closed_period_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
607
+ def get_closed_period_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
608
608
  """[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501
609
609
 
610
610
  Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # noqa: E501
@@ -616,13 +616,13 @@ class TimelinesApi:
616
616
 
617
617
  :param scope: The scope of the Timeline. (required)
618
618
  :type scope: str
619
- :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
619
+ :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
620
620
  :type code: str
621
- :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
621
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
622
622
  :type closed_period_id: str
623
- :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
623
+ :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
624
624
  :type as_at: datetime
625
- :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
625
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
626
626
  :type property_keys: List[str]
627
627
  :param async_req: Whether to execute the request asynchronously.
628
628
  :type async_req: bool, optional
@@ -745,18 +745,18 @@ class TimelinesApi:
745
745
 
746
746
 
747
747
  @overload
748
- async def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, **kwargs) -> Timeline: # noqa: E501
748
+ async def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, **kwargs) -> Timeline: # noqa: E501
749
749
  ...
750
750
 
751
751
  @overload
752
- def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> Timeline: # noqa: E501
752
+ def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> Timeline: # noqa: E501
753
753
  ...
754
754
 
755
755
  @validate_arguments
756
- def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Timeline, Awaitable[Timeline]]: # noqa: E501
756
+ def get_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Timeline, Awaitable[Timeline]]: # noqa: E501
757
757
  """[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. # noqa: E501
758
758
 
759
- Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501
759
+ Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501
760
760
  This method makes a synchronous HTTP request by default. To make an
761
761
  asynchronous HTTP request, please pass async_req=True
762
762
 
@@ -765,13 +765,13 @@ class TimelinesApi:
765
765
 
766
766
  :param scope: The scope of the specified Timeline. (required)
767
767
  :type scope: str
768
- :param code: The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
768
+ :param code: The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
769
769
  :type code: str
770
- :param as_at: The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.
770
+ :param as_at: The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.
771
771
  :type as_at: datetime
772
- :param effective_at: The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.
772
+ :param effective_at: The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.
773
773
  :type effective_at: str
774
- :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.
774
+ :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.
775
775
  :type property_keys: List[str]
776
776
  :param async_req: Whether to execute the request asynchronously.
777
777
  :type async_req: bool, optional
@@ -792,10 +792,10 @@ class TimelinesApi:
792
792
  return self.get_timeline_with_http_info(scope, code, as_at, effective_at, property_keys, **kwargs) # noqa: E501
793
793
 
794
794
  @validate_arguments
795
- def get_timeline_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
795
+ def get_timeline_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
796
796
  """[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. # noqa: E501
797
797
 
798
- Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501
798
+ Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501
799
799
  This method makes a synchronous HTTP request by default. To make an
800
800
  asynchronous HTTP request, please pass async_req=True
801
801
 
@@ -804,13 +804,13 @@ class TimelinesApi:
804
804
 
805
805
  :param scope: The scope of the specified Timeline. (required)
806
806
  :type scope: str
807
- :param code: The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
807
+ :param code: The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline. (required)
808
808
  :type code: str
809
- :param as_at: The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.
809
+ :param as_at: The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.
810
810
  :type as_at: datetime
811
- :param effective_at: The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.
811
+ :param effective_at: The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.
812
812
  :type effective_at: str
813
- :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.
813
+ :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.
814
814
  :type property_keys: List[str]
815
815
  :param async_req: Whether to execute the request asynchronously.
816
816
  :type async_req: bool, optional
@@ -933,15 +933,15 @@ class TimelinesApi:
933
933
 
934
934
 
935
935
  @overload
936
- async def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, **kwargs) -> PagedResourceListOfClosedPeriod: # noqa: E501
936
+ async def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, **kwargs) -> PagedResourceListOfClosedPeriod: # noqa: E501
937
937
  ...
938
938
 
939
939
  @overload
940
- def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfClosedPeriod: # noqa: E501
940
+ def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfClosedPeriod: # noqa: E501
941
941
  ...
942
942
 
943
943
  @validate_arguments
944
- def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfClosedPeriod, Awaitable[PagedResourceListOfClosedPeriod]]: # noqa: E501
944
+ def list_closed_periods(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfClosedPeriod, Awaitable[PagedResourceListOfClosedPeriod]]: # noqa: E501
945
945
  """[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. # noqa: E501
946
946
 
947
947
  List all the ClosedPeriods matching a particular criteria. # noqa: E501
@@ -957,15 +957,15 @@ class TimelinesApi:
957
957
  :type code: str
958
958
  :param as_at: The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.
959
959
  :type as_at: datetime
960
- :param page: The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
960
+ :param page: The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
961
961
  :type page: str
962
962
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
963
963
  :type limit: int
964
- :param filter: Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
964
+ :param filter: Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
965
965
  :type filter: str
966
966
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
967
967
  :type sort_by: List[str]
968
- :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.
968
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.
969
969
  :type property_keys: List[str]
970
970
  :param async_req: Whether to execute the request asynchronously.
971
971
  :type async_req: bool, optional
@@ -986,7 +986,7 @@ class TimelinesApi:
986
986
  return self.list_closed_periods_with_http_info(scope, code, as_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
987
987
 
988
988
  @validate_arguments
989
- def list_closed_periods_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
989
+ def list_closed_periods_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
990
990
  """[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. # noqa: E501
991
991
 
992
992
  List all the ClosedPeriods matching a particular criteria. # noqa: E501
@@ -1002,15 +1002,15 @@ class TimelinesApi:
1002
1002
  :type code: str
1003
1003
  :param as_at: The asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified.
1004
1004
  :type as_at: datetime
1005
- :param page: The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1005
+ :param page: The pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1006
1006
  :type page: str
1007
1007
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1008
1008
  :type limit: int
1009
- :param filter: Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1009
+ :param filter: Expression to filter the results. For example, to filter on the effectiveEnd, specify \"effectiveEnd gt 2019-01-15T10:00:00\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1010
1010
  :type filter: str
1011
1011
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
1012
1012
  :type sort_by: List[str]
1013
- :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.
1013
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example 'ClosedPeriod/Account/id'.
1014
1014
  :type property_keys: List[str]
1015
1015
  :param async_req: Whether to execute the request asynchronously.
1016
1016
  :type async_req: bool, optional
@@ -1146,15 +1146,15 @@ class TimelinesApi:
1146
1146
 
1147
1147
 
1148
1148
  @overload
1149
- async def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, **kwargs) -> PagedResourceListOfTimeline: # noqa: E501
1149
+ async def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, **kwargs) -> PagedResourceListOfTimeline: # noqa: E501
1150
1150
  ...
1151
1151
 
1152
1152
  @overload
1153
- def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfTimeline: # noqa: E501
1153
+ def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfTimeline: # noqa: E501
1154
1154
  ...
1155
1155
 
1156
1156
  @validate_arguments
1157
- def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfTimeline, Awaitable[PagedResourceListOfTimeline]]: # noqa: E501
1157
+ def list_timelines(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfTimeline, Awaitable[PagedResourceListOfTimeline]]: # noqa: E501
1158
1158
  """[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501
1159
1159
 
1160
1160
  List all the Timelines matching a particular criteria. # noqa: E501
@@ -1166,17 +1166,17 @@ class TimelinesApi:
1166
1166
 
1167
1167
  :param as_at: The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.
1168
1168
  :type as_at: datetime
1169
- :param effective_at: The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
1169
+ :param effective_at: The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
1170
1170
  :type effective_at: str
1171
- :param page: The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1171
+ :param page: The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1172
1172
  :type page: str
1173
1173
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1174
1174
  :type limit: int
1175
- :param filter: Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1175
+ :param filter: Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1176
1176
  :type filter: str
1177
1177
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
1178
1178
  :type sort_by: List[str]
1179
- :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.
1179
+ :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.
1180
1180
  :type property_keys: List[str]
1181
1181
  :param async_req: Whether to execute the request asynchronously.
1182
1182
  :type async_req: bool, optional
@@ -1197,7 +1197,7 @@ class TimelinesApi:
1197
1197
  return self.list_timelines_with_http_info(as_at, effective_at, page, limit, filter, sort_by, property_keys, **kwargs) # noqa: E501
1198
1198
 
1199
1199
  @validate_arguments
1200
- def list_timelines_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1200
+ def list_timelines_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = 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 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1201
1201
  """[EXPERIMENTAL] ListTimelines: List Timelines # noqa: E501
1202
1202
 
1203
1203
  List all the Timelines matching a particular criteria. # noqa: E501
@@ -1209,17 +1209,17 @@ class TimelinesApi:
1209
1209
 
1210
1210
  :param as_at: The asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified.
1211
1211
  :type as_at: datetime
1212
- :param effective_at: The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
1212
+ :param effective_at: The effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified.
1213
1213
  :type effective_at: str
1214
- :param page: The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1214
+ :param page: The pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1215
1215
  :type page: str
1216
1216
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1217
1217
  :type limit: int
1218
- :param filter: Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1218
+ :param filter: Expression to filter the results. For example, to filter on the displayName, specify \"displayName eq 'AccountingTimeline'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1219
1219
  :type filter: str
1220
1220
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
1221
1221
  :type sort_by: List[str]
1222
- :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.
1222
+ :param property_keys: A list of property keys from the 'Timeline' domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example 'Timeline/Account/id'.
1223
1223
  :type property_keys: List[str]
1224
1224
  :param async_req: Whether to execute the request asynchronously.
1225
1225
  :type async_req: bool, optional
@@ -1351,15 +1351,15 @@ class TimelinesApi:
1351
1351
 
1352
1352
 
1353
1353
  @overload
1354
- async def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
1354
+ async def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
1355
1355
  ...
1356
1356
 
1357
1357
  @overload
1358
- def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
1358
+ def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
1359
1359
  ...
1360
1360
 
1361
1361
  @validate_arguments
1362
- def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
1362
+ def set_post_close_activity(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
1363
1363
  """[EXPERIMENTAL] SetPostCloseActivity: Sets post close activities to a closed period. # noqa: E501
1364
1364
 
1365
1365
  Sets empty or more post close activities to the specific closed period. # noqa: E501
@@ -1373,7 +1373,7 @@ class TimelinesApi:
1373
1373
  :type scope: str
1374
1374
  :param code: The code of the Timeline. (required)
1375
1375
  :type code: str
1376
- :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
1376
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
1377
1377
  :type closed_period_id: str
1378
1378
  :param post_close_activities_request: Specifies collection of post close activities
1379
1379
  :type post_close_activities_request: PostCloseActivitiesRequest
@@ -1396,7 +1396,7 @@ class TimelinesApi:
1396
1396
  return self.set_post_close_activity_with_http_info(scope, code, closed_period_id, post_close_activities_request, **kwargs) # noqa: E501
1397
1397
 
1398
1398
  @validate_arguments
1399
- def set_post_close_activity_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, **kwargs) -> ApiResponse: # noqa: E501
1399
+ def set_post_close_activity_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the Timeline.")], closed_period_id : Annotated[StrictStr, Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], post_close_activities_request : Annotated[Optional[PostCloseActivitiesRequest], Field(description="Specifies collection of post close activities")] = None, **kwargs) -> ApiResponse: # noqa: E501
1400
1400
  """[EXPERIMENTAL] SetPostCloseActivity: Sets post close activities to a closed period. # noqa: E501
1401
1401
 
1402
1402
  Sets empty or more post close activities to the specific closed period. # noqa: E501
@@ -1410,7 +1410,7 @@ class TimelinesApi:
1410
1410
  :type scope: str
1411
1411
  :param code: The code of the Timeline. (required)
1412
1412
  :type code: str
1413
- :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
1413
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
1414
1414
  :type closed_period_id: str
1415
1415
  :param post_close_activities_request: Specifies collection of post close activities
1416
1416
  :type post_close_activities_request: PostCloseActivitiesRequest
@@ -1545,7 +1545,7 @@ class TimelinesApi:
1545
1545
  def update_timeline(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], update_timeline_request : Annotated[Optional[UpdateTimelineRequest], Field(description="The request containing the updated details of the Timeline")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Timeline, Awaitable[Timeline]]: # noqa: E501
1546
1546
  """[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501
1547
1547
 
1548
- Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
1548
+ Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
1549
1549
  This method makes a synchronous HTTP request by default. To make an
1550
1550
  asynchronous HTTP request, please pass async_req=True
1551
1551
 
@@ -1580,7 +1580,7 @@ class TimelinesApi:
1580
1580
  def update_timeline_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the specified Timeline.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], update_timeline_request : Annotated[Optional[UpdateTimelineRequest], Field(description="The request containing the updated details of the Timeline")] = None, **kwargs) -> ApiResponse: # noqa: E501
1581
1581
  """[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code # noqa: E501
1582
1582
 
1583
- Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
1583
+ Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501
1584
1584
  This method makes a synchronous HTTP request by default. To make an
1585
1585
  asynchronous HTTP request, please pass async_req=True
1586
1586