lusid-sdk 2.1.721__py3-none-any.whl → 2.1.723__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 (1213) hide show
  1. lusid/api/abor_api.py +74 -56
  2. lusid/api/abor_configuration_api.py +34 -24
  3. lusid/api/address_key_definition_api.py +11 -4
  4. lusid/api/aggregation_api.py +16 -8
  5. lusid/api/allocations_api.py +20 -12
  6. lusid/api/amortisation_rule_sets_api.py +34 -24
  7. lusid/api/application_metadata_api.py +15 -8
  8. lusid/api/blocks_api.py +20 -12
  9. lusid/api/calendars_api.py +70 -52
  10. lusid/api/chart_of_accounts_api.py +174 -136
  11. lusid/api/complex_market_data_api.py +20 -12
  12. lusid/api/compliance_api.py +71 -52
  13. lusid/api/configuration_recipe_api.py +47 -32
  14. lusid/api/conventions_api.py +40 -24
  15. lusid/api/corporate_action_sources_api.py +45 -32
  16. lusid/api/counterparties_api.py +28 -16
  17. lusid/api/custom_data_models_api.py +30 -20
  18. lusid/api/custom_entities_api.py +59 -44
  19. lusid/api/custom_entity_definitions_api.py +20 -12
  20. lusid/api/custom_entity_types_api.py +20 -12
  21. lusid/api/cut_label_definitions_api.py +25 -16
  22. lusid/api/data_types_api.py +45 -32
  23. lusid/api/derived_transaction_portfolios_api.py +14 -8
  24. lusid/api/entities_api.py +39 -28
  25. lusid/api/executions_api.py +20 -12
  26. lusid/api/fee_types_api.py +30 -20
  27. lusid/api/fund_configuration_api.py +34 -24
  28. lusid/api/funds_api.py +129 -100
  29. lusid/api/group_reconciliations_api.py +66 -48
  30. lusid/api/identifier_definitions_api.py +25 -16
  31. lusid/api/instrument_event_types_api.py +35 -24
  32. lusid/api/instrument_events_api.py +25 -16
  33. lusid/api/instruments_api.py +105 -80
  34. lusid/api/legacy_compliance_api.py +44 -32
  35. lusid/api/legal_entities_api.py +90 -68
  36. lusid/api/order_graph_api.py +19 -12
  37. lusid/api/order_instructions_api.py +20 -12
  38. lusid/api/order_management_api.py +23 -8
  39. lusid/api/orders_api.py +20 -12
  40. lusid/api/packages_api.py +20 -12
  41. lusid/api/participations_api.py +20 -12
  42. lusid/api/persons_api.py +90 -68
  43. lusid/api/placements_api.py +20 -12
  44. lusid/api/portfolio_groups_api.py +134 -104
  45. lusid/api/portfolios_api.py +159 -124
  46. lusid/api/property_definitions_api.py +51 -36
  47. lusid/api/queryable_keys_api.py +9 -4
  48. lusid/api/quotes_api.py +49 -36
  49. lusid/api/reconciliations_api.py +55 -36
  50. lusid/api/reference_lists_api.py +20 -12
  51. lusid/api/reference_portfolio_api.py +29 -20
  52. lusid/api/relation_definitions_api.py +15 -8
  53. lusid/api/relations_api.py +14 -8
  54. lusid/api/relationship_definitions_api.py +25 -16
  55. lusid/api/relationships_api.py +14 -8
  56. lusid/api/schemas_api.py +12 -4
  57. lusid/api/scopes_api.py +14 -8
  58. lusid/api/scripted_translation_api.py +28 -16
  59. lusid/api/search_api.py +24 -16
  60. lusid/api/sequences_api.py +24 -16
  61. lusid/api/simple_position_portfolios_api.py +9 -4
  62. lusid/api/staged_modifications_api.py +24 -16
  63. lusid/api/staging_rule_set_api.py +29 -20
  64. lusid/api/structured_result_data_api.py +49 -36
  65. lusid/api/system_configuration_api.py +23 -12
  66. lusid/api/tax_rule_sets_api.py +29 -20
  67. lusid/api/timelines_api.py +35 -24
  68. lusid/api/transaction_configuration_api.py +59 -44
  69. lusid/api/transaction_fees_api.py +29 -20
  70. lusid/api/transaction_portfolios_api.py +204 -160
  71. lusid/api/translation_api.py +6 -0
  72. lusid/api/workspace_api.py +96 -72
  73. lusid/configuration.py +1 -1
  74. lusid/models/a2_b_breakdown.py +2 -2
  75. lusid/models/a2_b_category.py +1 -1
  76. lusid/models/a2_b_data_record.py +7 -7
  77. lusid/models/a2_b_movement_record.py +8 -8
  78. lusid/models/abor.py +5 -5
  79. lusid/models/abor_configuration.py +4 -4
  80. lusid/models/abor_configuration_properties.py +2 -2
  81. lusid/models/abor_configuration_request.py +4 -21
  82. lusid/models/abor_properties.py +2 -2
  83. lusid/models/abor_request.py +4 -21
  84. lusid/models/accept_estimate_valuation_point_response.py +2 -2
  85. lusid/models/access_controlled_action.py +2 -2
  86. lusid/models/access_controlled_resource.py +4 -4
  87. lusid/models/access_metadata_operation.py +4 -11
  88. lusid/models/access_metadata_value.py +3 -3
  89. lusid/models/account.py +6 -23
  90. lusid/models/account_properties.py +2 -2
  91. lusid/models/accounted_transaction.py +2 -2
  92. lusid/models/accounts_upsert_response.py +2 -2
  93. lusid/models/accumulation_event.py +3 -3
  94. lusid/models/action_id.py +4 -4
  95. lusid/models/add_business_days_to_date_request.py +1 -1
  96. lusid/models/add_business_days_to_date_response.py +1 -1
  97. lusid/models/additional_payment.py +3 -3
  98. lusid/models/address_definition.py +6 -6
  99. lusid/models/address_key_compliance_parameter.py +3 -3
  100. lusid/models/address_key_definition.py +3 -3
  101. lusid/models/address_key_filter.py +3 -3
  102. lusid/models/address_key_list.py +2 -2
  103. lusid/models/address_key_list_compliance_parameter.py +2 -2
  104. lusid/models/address_key_option_definition.py +5 -5
  105. lusid/models/adjust_global_commitment_event.py +2 -2
  106. lusid/models/adjust_holding.py +2 -2
  107. lusid/models/adjust_holding_for_date_request.py +3 -3
  108. lusid/models/adjust_holding_request.py +2 -2
  109. lusid/models/aggregate_spec.py +3 -3
  110. lusid/models/aggregated_return.py +2 -2
  111. lusid/models/aggregated_returns_dispersion_request.py +4 -14
  112. lusid/models/aggregated_returns_request.py +7 -7
  113. lusid/models/aggregated_returns_response.py +2 -2
  114. lusid/models/aggregated_transactions_request.py +1 -1
  115. lusid/models/aggregation_context.py +1 -1
  116. lusid/models/aggregation_measure_failure_detail.py +5 -5
  117. lusid/models/aggregation_options.py +1 -1
  118. lusid/models/aggregation_query.py +8 -8
  119. lusid/models/alias.py +3 -3
  120. lusid/models/allocation.py +8 -8
  121. lusid/models/allocation_request.py +6 -6
  122. lusid/models/allocation_service_run_response.py +1 -1
  123. lusid/models/allocation_set_request.py +1 -1
  124. lusid/models/amortisation_event.py +4 -4
  125. lusid/models/amortisation_rule.py +5 -29
  126. lusid/models/amortisation_rule_set.py +4 -21
  127. lusid/models/amount.py +1 -1
  128. lusid/models/annul_quotes_response.py +2 -2
  129. lusid/models/annul_single_structured_data_response.py +2 -2
  130. lusid/models/annul_structured_data_response.py +2 -2
  131. lusid/models/applicable_instrument_event.py +7 -7
  132. lusid/models/asset_leg.py +2 -2
  133. lusid/models/barrier.py +4 -4
  134. lusid/models/basket.py +3 -3
  135. lusid/models/basket_identifier.py +4 -4
  136. lusid/models/batch_adjust_holdings_response.py +1 -1
  137. lusid/models/batch_update_user_review_for_comparison_result_request.py +2 -2
  138. lusid/models/batch_update_user_review_for_comparison_result_response.py +1 -1
  139. lusid/models/batch_upsert_dates_for_calendar_response.py +1 -1
  140. lusid/models/batch_upsert_instrument_properties_response.py +1 -1
  141. lusid/models/batch_upsert_portfolio_access_metadata_request.py +1 -1
  142. lusid/models/batch_upsert_portfolio_access_metadata_response.py +1 -1
  143. lusid/models/batch_upsert_portfolio_access_metadata_response_item.py +1 -1
  144. lusid/models/batch_upsert_portfolio_transactions_response.py +1 -1
  145. lusid/models/batch_upsert_property_definition_properties_response.py +1 -1
  146. lusid/models/block.py +5 -5
  147. lusid/models/block_and_order_id_request.py +1 -1
  148. lusid/models/block_and_orders.py +1 -1
  149. lusid/models/block_and_orders_create_request.py +1 -1
  150. lusid/models/block_and_orders_request.py +4 -4
  151. lusid/models/block_request.py +4 -4
  152. lusid/models/block_set_request.py +1 -1
  153. lusid/models/blocked_order_request.py +3 -3
  154. lusid/models/bond.py +4 -4
  155. lusid/models/bond_conversion_entry.py +1 -1
  156. lusid/models/bond_conversion_schedule.py +5 -5
  157. lusid/models/bond_coupon_event.py +3 -3
  158. lusid/models/bond_default_event.py +2 -2
  159. lusid/models/bond_principal_event.py +3 -3
  160. lusid/models/bonus_issue_event.py +3 -3
  161. lusid/models/book_transactions_request.py +1 -1
  162. lusid/models/book_transactions_response.py +1 -1
  163. lusid/models/bool_compliance_parameter.py +2 -2
  164. lusid/models/bool_list_compliance_parameter.py +2 -2
  165. lusid/models/branch_step.py +3 -3
  166. lusid/models/branch_step_request.py +3 -10
  167. lusid/models/break_code_source.py +1 -1
  168. lusid/models/bucketed_cash_flow_request.py +8 -18
  169. lusid/models/bucketed_cash_flow_response.py +3 -3
  170. lusid/models/bucketing_schedule.py +2 -2
  171. lusid/models/calculation_info.py +3 -3
  172. lusid/models/calendar.py +4 -4
  173. lusid/models/calendar_date.py +7 -7
  174. lusid/models/calendar_dependency.py +2 -2
  175. lusid/models/call_on_intermediate_securities_event.py +3 -3
  176. lusid/models/cancel_order_and_move_remaining_result.py +1 -1
  177. lusid/models/cancel_orders_and_move_remaining_request.py +1 -1
  178. lusid/models/cancel_orders_and_move_remaining_response.py +2 -2
  179. lusid/models/cancel_orders_response.py +2 -2
  180. lusid/models/cancel_placements_response.py +2 -2
  181. lusid/models/cancel_single_holding_adjustment_request.py +2 -2
  182. lusid/models/cancelled_order_result.py +1 -1
  183. lusid/models/cancelled_placement_result.py +1 -1
  184. lusid/models/cap_floor.py +3 -3
  185. lusid/models/capital_distribution_event.py +2 -2
  186. lusid/models/cash.py +3 -3
  187. lusid/models/cash_and_security_offer_election.py +3 -3
  188. lusid/models/cash_dependency.py +3 -3
  189. lusid/models/cash_dividend_event.py +2 -2
  190. lusid/models/cash_election.py +3 -3
  191. lusid/models/cash_flow_event.py +3 -3
  192. lusid/models/cash_flow_lineage.py +7 -7
  193. lusid/models/cash_flow_value.py +3 -3
  194. lusid/models/cash_flow_value_set.py +2 -2
  195. lusid/models/cash_ladder_record.py +1 -1
  196. lusid/models/cash_offer_election.py +3 -3
  197. lusid/models/cash_perpetual.py +3 -3
  198. lusid/models/cds_credit_event.py +2 -2
  199. lusid/models/cds_flow_conventions.py +9 -29
  200. lusid/models/cds_index.py +2 -2
  201. lusid/models/cds_protection_detail_specification.py +3 -3
  202. lusid/models/cdx_credit_event.py +3 -3
  203. lusid/models/change.py +2 -2
  204. lusid/models/change_history.py +4 -4
  205. lusid/models/change_interval.py +6 -6
  206. lusid/models/change_interval_with_order_management_detail.py +7 -7
  207. lusid/models/change_item.py +4 -4
  208. lusid/models/chart_of_accounts.py +4 -4
  209. lusid/models/chart_of_accounts_properties.py +2 -2
  210. lusid/models/chart_of_accounts_request.py +4 -21
  211. lusid/models/check_step.py +3 -3
  212. lusid/models/check_step_request.py +3 -10
  213. lusid/models/cleardown_module_details.py +4 -21
  214. lusid/models/cleardown_module_request.py +4 -28
  215. lusid/models/cleardown_module_response.py +6 -16
  216. lusid/models/cleardown_module_rule.py +4 -25
  217. lusid/models/cleardown_module_rules_updated_response.py +2 -2
  218. lusid/models/client.py +2 -2
  219. lusid/models/close_event.py +2 -2
  220. lusid/models/close_period_diary_entry_request.py +4 -24
  221. lusid/models/closed_period.py +3 -3
  222. lusid/models/comparison_attribute_value_pair.py +3 -3
  223. lusid/models/complete_portfolio.py +6 -6
  224. lusid/models/complete_relation.py +4 -4
  225. lusid/models/complete_relationship.py +4 -4
  226. lusid/models/complex_bond.py +4 -4
  227. lusid/models/complex_market_data.py +2 -2
  228. lusid/models/complex_market_data_id.py +6 -6
  229. lusid/models/compliance_breached_order_info.py +1 -1
  230. lusid/models/compliance_parameter.py +2 -2
  231. lusid/models/compliance_rule.py +10 -20
  232. lusid/models/compliance_rule_breakdown.py +2 -2
  233. lusid/models/compliance_rule_breakdown_request.py +2 -2
  234. lusid/models/compliance_rule_response.py +4 -4
  235. lusid/models/compliance_rule_result.py +6 -6
  236. lusid/models/compliance_rule_result_detail.py +7 -7
  237. lusid/models/compliance_rule_result_portfolio_detail.py +2 -2
  238. lusid/models/compliance_rule_result_v2.py +2 -2
  239. lusid/models/compliance_rule_template.py +3 -13
  240. lusid/models/compliance_rule_upsert_request.py +10 -57
  241. lusid/models/compliance_rule_upsert_response.py +1 -1
  242. lusid/models/compliance_run_configuration.py +1 -1
  243. lusid/models/compliance_run_info.py +3 -3
  244. lusid/models/compliance_run_info_v2.py +3 -3
  245. lusid/models/compliance_step.py +2 -2
  246. lusid/models/compliance_step_request.py +2 -2
  247. lusid/models/compliance_summary_rule_result.py +3 -3
  248. lusid/models/compliance_summary_rule_result_request.py +3 -3
  249. lusid/models/compliance_template.py +2 -2
  250. lusid/models/compliance_template_parameter.py +4 -4
  251. lusid/models/compliance_template_variation.py +4 -4
  252. lusid/models/compliance_template_variation_dto.py +5 -22
  253. lusid/models/compliance_template_variation_request.py +5 -22
  254. lusid/models/component_filter.py +3 -17
  255. lusid/models/component_transaction.py +3 -3
  256. lusid/models/composite_breakdown.py +1 -1
  257. lusid/models/composite_breakdown_request.py +4 -4
  258. lusid/models/composite_breakdown_response.py +2 -2
  259. lusid/models/composite_dispersion.py +1 -1
  260. lusid/models/composite_dispersion_response.py +2 -2
  261. lusid/models/compounding.py +6 -6
  262. lusid/models/configuration_recipe.py +4 -28
  263. lusid/models/constant_volatility_surface.py +4 -4
  264. lusid/models/constituents_adjustment_header.py +1 -1
  265. lusid/models/contract_details.py +5 -5
  266. lusid/models/contract_for_difference.py +7 -7
  267. lusid/models/contract_initialisation_event.py +2 -2
  268. lusid/models/contribution_to_non_passing_rule_detail.py +2 -2
  269. lusid/models/corporate_action.py +3 -3
  270. lusid/models/corporate_action_source.py +4 -4
  271. lusid/models/corporate_action_transition.py +1 -1
  272. lusid/models/corporate_action_transition_component.py +3 -3
  273. lusid/models/corporate_action_transition_component_request.py +1 -1
  274. lusid/models/corporate_action_transition_request.py +1 -1
  275. lusid/models/counterparty_agreement.py +3 -3
  276. lusid/models/counterparty_risk_information.py +2 -9
  277. lusid/models/counterparty_signatory.py +2 -2
  278. lusid/models/create_address_key_definition_request.py +3 -3
  279. lusid/models/create_amortisation_rule_set_request.py +4 -28
  280. lusid/models/create_calendar_request.py +3 -17
  281. lusid/models/create_closed_period_request.py +2 -2
  282. lusid/models/create_compliance_template_request.py +3 -17
  283. lusid/models/create_corporate_action_source_request.py +5 -36
  284. lusid/models/create_custom_data_model_request.py +4 -28
  285. lusid/models/create_custom_entity_type_request.py +4 -18
  286. lusid/models/create_cut_label_definition_request.py +5 -22
  287. lusid/models/create_data_map_request.py +1 -1
  288. lusid/models/create_data_type_request.py +8 -36
  289. lusid/models/create_date_request.py +5 -36
  290. lusid/models/create_derived_property_definition_request.py +7 -7
  291. lusid/models/create_derived_transaction_portfolio_request.py +8 -42
  292. lusid/models/create_group_reconciliation_comparison_ruleset_request.py +3 -3
  293. lusid/models/create_group_reconciliation_definition_request.py +3 -3
  294. lusid/models/create_identifier_definition_request.py +9 -53
  295. lusid/models/create_portfolio_details.py +1 -1
  296. lusid/models/create_portfolio_group_request.py +4 -4
  297. lusid/models/create_property_definition_request.py +9 -9
  298. lusid/models/create_recipe_request.py +2 -2
  299. lusid/models/create_reconciliation_request.py +4 -11
  300. lusid/models/create_reference_portfolio_request.py +5 -5
  301. lusid/models/create_relation_definition_request.py +10 -10
  302. lusid/models/create_relation_request.py +1 -1
  303. lusid/models/create_relationship_definition_request.py +10 -45
  304. lusid/models/create_relationship_request.py +3 -23
  305. lusid/models/create_sequence_request.py +3 -20
  306. lusid/models/create_simple_position_portfolio_request.py +9 -26
  307. lusid/models/create_staging_rule_set_request.py +3 -3
  308. lusid/models/create_tax_rule_set_request.py +4 -18
  309. lusid/models/create_timeline_request.py +3 -3
  310. lusid/models/create_trade_tickets_response.py +1 -1
  311. lusid/models/create_transaction_portfolio_request.py +9 -19
  312. lusid/models/create_unit_definition.py +4 -25
  313. lusid/models/credit_default_swap.py +3 -3
  314. lusid/models/credit_premium_cash_flow_event.py +3 -3
  315. lusid/models/credit_rating.py +3 -17
  316. lusid/models/credit_spread_curve_data.py +4 -4
  317. lusid/models/credit_support_annex.py +5 -5
  318. lusid/models/currency_and_amount.py +2 -2
  319. lusid/models/curve_options.py +5 -5
  320. lusid/models/custodian_account.py +7 -7
  321. lusid/models/custodian_account_properties.py +2 -2
  322. lusid/models/custodian_account_request.py +9 -33
  323. lusid/models/custodian_accounts_upsert_response.py +2 -2
  324. lusid/models/custom_data_model.py +1 -1
  325. lusid/models/custom_data_model_criteria.py +2 -2
  326. lusid/models/custom_data_model_identifier_type_specification.py +2 -2
  327. lusid/models/custom_data_model_identifier_type_specification_with_display_name.py +3 -3
  328. lusid/models/custom_data_model_property_specification.py +2 -2
  329. lusid/models/custom_data_model_property_specification_with_display_name.py +3 -3
  330. lusid/models/custom_entity_definition.py +6 -6
  331. lusid/models/custom_entity_definition_request.py +4 -18
  332. lusid/models/custom_entity_entity.py +7 -7
  333. lusid/models/custom_entity_field.py +2 -2
  334. lusid/models/custom_entity_field_definition.py +6 -6
  335. lusid/models/custom_entity_id.py +4 -25
  336. lusid/models/custom_entity_request.py +3 -3
  337. lusid/models/custom_entity_response.py +5 -5
  338. lusid/models/custom_entity_type.py +6 -6
  339. lusid/models/cut_label_definition.py +6 -6
  340. lusid/models/cut_local_time.py +1 -1
  341. lusid/models/data_definition.py +5 -15
  342. lusid/models/data_map_key.py +3 -23
  343. lusid/models/data_mapping.py +1 -1
  344. lusid/models/data_model_membership.py +1 -1
  345. lusid/models/data_model_summary.py +5 -5
  346. lusid/models/data_scope.py +2 -2
  347. lusid/models/data_type.py +7 -7
  348. lusid/models/data_type_entity.py +7 -7
  349. lusid/models/data_type_summary.py +6 -6
  350. lusid/models/date_attributes.py +6 -56
  351. lusid/models/date_or_diary_entry.py +3 -13
  352. lusid/models/date_range.py +1 -1
  353. lusid/models/date_time_compliance_parameter.py +2 -2
  354. lusid/models/date_time_list_compliance_parameter.py +2 -2
  355. lusid/models/day_month.py +1 -1
  356. lusid/models/decimal_compliance_parameter.py +2 -2
  357. lusid/models/decimal_list.py +2 -2
  358. lusid/models/decimal_list_compliance_parameter.py +2 -2
  359. lusid/models/decorated_compliance_run_summary.py +1 -1
  360. lusid/models/delete_accounts_response.py +1 -1
  361. lusid/models/delete_custodian_accounts_response.py +1 -1
  362. lusid/models/delete_instrument_properties_response.py +1 -1
  363. lusid/models/delete_instrument_response.py +2 -2
  364. lusid/models/delete_instruments_response.py +2 -2
  365. lusid/models/delete_relation_request.py +1 -1
  366. lusid/models/delete_relationship_request.py +3 -23
  367. lusid/models/deleted_entity_response.py +4 -4
  368. lusid/models/dependency_source_filter.py +5 -5
  369. lusid/models/deposit_close_event.py +2 -2
  370. lusid/models/deposit_interest_payment_event.py +3 -3
  371. lusid/models/described_address_key.py +3 -3
  372. lusid/models/dialect.py +1 -1
  373. lusid/models/dialect_id.py +7 -35
  374. lusid/models/dialect_schema.py +3 -3
  375. lusid/models/diary_entry.py +6 -16
  376. lusid/models/diary_entry_request.py +4 -21
  377. lusid/models/discount_factor_curve_data.py +3 -3
  378. lusid/models/discounting_dependency.py +3 -3
  379. lusid/models/dividend_option_event.py +2 -2
  380. lusid/models/dividend_reinvestment_event.py +2 -2
  381. lusid/models/drawdown_event.py +2 -2
  382. lusid/models/early_redemption_election.py +2 -2
  383. lusid/models/early_redemption_event.py +3 -3
  384. lusid/models/economic_dependency.py +2 -2
  385. lusid/models/economic_dependency_with_complex_market_data.py +1 -1
  386. lusid/models/economic_dependency_with_quote.py +1 -1
  387. lusid/models/effective_range.py +1 -1
  388. lusid/models/election_specification.py +2 -2
  389. lusid/models/eligibility_calculation.py +3 -3
  390. lusid/models/empty_model_options.py +2 -2
  391. lusid/models/entity_identifier.py +4 -4
  392. lusid/models/equity.py +3 -3
  393. lusid/models/equity_all_of_identifiers.py +12 -12
  394. lusid/models/equity_curve_by_prices_data.py +3 -3
  395. lusid/models/equity_curve_dependency.py +5 -5
  396. lusid/models/equity_model_options.py +3 -3
  397. lusid/models/equity_option.py +10 -10
  398. lusid/models/equity_swap.py +5 -5
  399. lusid/models/equity_vol_dependency.py +5 -5
  400. lusid/models/equity_vol_surface_data.py +3 -3
  401. lusid/models/error_detail.py +4 -4
  402. lusid/models/event_date_range.py +1 -1
  403. lusid/models/ex_dividend_configuration.py +1 -1
  404. lusid/models/exchange_traded_option.py +2 -2
  405. lusid/models/exchange_traded_option_contract_details.py +11 -11
  406. lusid/models/execution.py +7 -7
  407. lusid/models/execution_request.py +6 -6
  408. lusid/models/execution_set_request.py +1 -1
  409. lusid/models/exercise_event.py +2 -2
  410. lusid/models/exotic_instrument.py +3 -3
  411. lusid/models/expanded_group.py +4 -4
  412. lusid/models/expiry_event.py +2 -2
  413. lusid/models/external_fee_component_filter.py +4 -25
  414. lusid/models/fee.py +11 -31
  415. lusid/models/fee_accrual.py +3 -10
  416. lusid/models/fee_properties.py +2 -2
  417. lusid/models/fee_request.py +10 -27
  418. lusid/models/fee_rule.py +12 -12
  419. lusid/models/fee_rule_upsert_request.py +12 -32
  420. lusid/models/fee_rule_upsert_response.py +1 -1
  421. lusid/models/fee_transaction_template_specification.py +2 -2
  422. lusid/models/fee_type.py +4 -4
  423. lusid/models/fee_type_request.py +4 -21
  424. lusid/models/field_definition.py +3 -10
  425. lusid/models/field_schema.py +4 -4
  426. lusid/models/field_value.py +2 -9
  427. lusid/models/file_response.py +3 -3
  428. lusid/models/filter_predicate_compliance_parameter.py +3 -3
  429. lusid/models/filter_step.py +3 -3
  430. lusid/models/filter_step_request.py +3 -10
  431. lusid/models/fixed_leg.py +2 -2
  432. lusid/models/fixed_leg_all_of_overrides.py +1 -1
  433. lusid/models/fixed_schedule.py +4 -4
  434. lusid/models/flexible_deposit.py +3 -3
  435. lusid/models/flexible_loan.py +3 -3
  436. lusid/models/float_schedule.py +5 -5
  437. lusid/models/floating_leg.py +2 -2
  438. lusid/models/flow_convention_name.py +4 -4
  439. lusid/models/flow_conventions.py +10 -30
  440. lusid/models/forward_rate_agreement.py +3 -3
  441. lusid/models/from_recipe.py +3 -3
  442. lusid/models/fund.py +5 -15
  443. lusid/models/fund_amount.py +1 -1
  444. lusid/models/fund_configuration.py +4 -4
  445. lusid/models/fund_configuration_properties.py +2 -2
  446. lusid/models/fund_configuration_request.py +4 -21
  447. lusid/models/fund_details.py +2 -2
  448. lusid/models/fund_id_list.py +2 -2
  449. lusid/models/fund_journal_entry_line.py +18 -18
  450. lusid/models/fund_pnl_breakdown.py +1 -1
  451. lusid/models/fund_previous_nav.py +1 -1
  452. lusid/models/fund_properties.py +2 -2
  453. lusid/models/fund_request.py +5 -22
  454. lusid/models/fund_share_class.py +7 -7
  455. lusid/models/fund_valuation_point_data.py +1 -1
  456. lusid/models/funding_leg.py +2 -2
  457. lusid/models/funding_leg_options.py +3 -3
  458. lusid/models/future.py +3 -3
  459. lusid/models/future_expiry_event.py +3 -3
  460. lusid/models/future_mark_to_market_event.py +3 -3
  461. lusid/models/futures_contract_details.py +12 -12
  462. lusid/models/fx_conventions.py +4 -4
  463. lusid/models/fx_dependency.py +4 -4
  464. lusid/models/fx_forward.py +5 -5
  465. lusid/models/fx_forward_curve_by_quote_reference.py +6 -6
  466. lusid/models/fx_forward_curve_data.py +5 -5
  467. lusid/models/fx_forward_model_options.py +4 -4
  468. lusid/models/fx_forward_pips_curve_data.py +5 -5
  469. lusid/models/fx_forward_settlement_event.py +5 -5
  470. lusid/models/fx_forward_tenor_curve_data.py +6 -6
  471. lusid/models/fx_forward_tenor_pips_curve_data.py +6 -6
  472. lusid/models/fx_forwards_dependency.py +5 -5
  473. lusid/models/fx_linked_notional_schedule.py +3 -3
  474. lusid/models/fx_option.py +6 -6
  475. lusid/models/fx_rate_schedule.py +3 -3
  476. lusid/models/fx_swap.py +3 -3
  477. lusid/models/fx_tenor_convention.py +2 -2
  478. lusid/models/fx_vol_dependency.py +5 -5
  479. lusid/models/fx_vol_surface_data.py +3 -3
  480. lusid/models/general_ledger_profile_mapping.py +2 -9
  481. lusid/models/general_ledger_profile_request.py +4 -28
  482. lusid/models/general_ledger_profile_response.py +5 -29
  483. lusid/models/generated_event_diagnostics.py +4 -4
  484. lusid/models/get_cds_flow_conventions_response.py +2 -2
  485. lusid/models/get_complex_market_data_response.py +2 -2
  486. lusid/models/get_counterparty_agreement_response.py +2 -2
  487. lusid/models/get_credit_support_annex_response.py +2 -2
  488. lusid/models/get_data_map_response.py +2 -2
  489. lusid/models/get_flow_conventions_response.py +2 -2
  490. lusid/models/get_index_convention_response.py +2 -2
  491. lusid/models/get_instruments_response.py +2 -2
  492. lusid/models/get_quotes_response.py +2 -2
  493. lusid/models/get_recipe_composer_response.py +2 -2
  494. lusid/models/get_recipe_response.py +2 -2
  495. lusid/models/get_reference_portfolio_constituents_response.py +4 -4
  496. lusid/models/get_structured_result_data_response.py +2 -2
  497. lusid/models/get_virtual_document_response.py +2 -2
  498. lusid/models/group_by_selector_compliance_parameter.py +3 -3
  499. lusid/models/group_by_step.py +3 -3
  500. lusid/models/group_by_step_request.py +3 -10
  501. lusid/models/group_calculation_compliance_parameter.py +3 -3
  502. lusid/models/group_filter_predicate_compliance_parameter.py +3 -3
  503. lusid/models/group_filter_step.py +3 -3
  504. lusid/models/group_filter_step_request.py +3 -10
  505. lusid/models/group_of_market_data_key_rules.py +2 -2
  506. lusid/models/group_reconciliation_aggregate_attribute_rule.py +1 -1
  507. lusid/models/group_reconciliation_aggregate_attribute_values.py +1 -1
  508. lusid/models/group_reconciliation_aggregate_comparison_rule_operand.py +3 -3
  509. lusid/models/group_reconciliation_comparison_result.py +7 -7
  510. lusid/models/group_reconciliation_comparison_rule_string_value_map.py +4 -4
  511. lusid/models/group_reconciliation_comparison_rule_tolerance.py +2 -2
  512. lusid/models/group_reconciliation_comparison_ruleset.py +4 -4
  513. lusid/models/group_reconciliation_core_attribute_rule.py +1 -1
  514. lusid/models/group_reconciliation_core_attribute_values.py +1 -1
  515. lusid/models/group_reconciliation_core_comparison_rule_operand.py +3 -3
  516. lusid/models/group_reconciliation_date_pair.py +1 -1
  517. lusid/models/group_reconciliation_dates.py +1 -1
  518. lusid/models/group_reconciliation_definition.py +4 -4
  519. lusid/models/group_reconciliation_definition_comparison_ruleset_ids.py +1 -1
  520. lusid/models/group_reconciliation_definition_currencies.py +3 -3
  521. lusid/models/group_reconciliation_definition_portfolio_entity_ids.py +1 -1
  522. lusid/models/group_reconciliation_definition_recipe_ids.py +1 -1
  523. lusid/models/group_reconciliation_instance_id.py +3 -3
  524. lusid/models/group_reconciliation_result_statuses.py +1 -1
  525. lusid/models/group_reconciliation_result_types.py +1 -1
  526. lusid/models/group_reconciliation_review_statuses.py +1 -1
  527. lusid/models/group_reconciliation_run_details.py +3 -3
  528. lusid/models/group_reconciliation_run_request.py +2 -2
  529. lusid/models/group_reconciliation_run_response.py +1 -1
  530. lusid/models/group_reconciliation_summary.py +2 -2
  531. lusid/models/group_reconciliation_user_review.py +1 -1
  532. lusid/models/group_reconciliation_user_review_add.py +4 -4
  533. lusid/models/group_reconciliation_user_review_break_code.py +3 -3
  534. lusid/models/group_reconciliation_user_review_comment.py +3 -3
  535. lusid/models/group_reconciliation_user_review_match_key.py +3 -3
  536. lusid/models/group_reconciliation_user_review_remove.py +1 -1
  537. lusid/models/grouped_result_of_address_key.py +1 -1
  538. lusid/models/holding_adjustment.py +4 -4
  539. lusid/models/holding_adjustment_with_date.py +4 -4
  540. lusid/models/holding_context.py +1 -1
  541. lusid/models/holding_contributor.py +1 -1
  542. lusid/models/holding_ids_request.py +1 -1
  543. lusid/models/holding_pricing_info.py +3 -3
  544. lusid/models/holdings_adjustment.py +2 -2
  545. lusid/models/holdings_adjustment_header.py +2 -2
  546. lusid/models/i_unit_definition_dto.py +5 -5
  547. lusid/models/id_selector_definition.py +3 -3
  548. lusid/models/identifier_definition.py +10 -44
  549. lusid/models/identifier_part_schema.py +4 -4
  550. lusid/models/index_convention.py +8 -28
  551. lusid/models/index_model_options.py +3 -3
  552. lusid/models/index_projection_dependency.py +5 -5
  553. lusid/models/industry_classifier.py +3 -10
  554. lusid/models/inflation_fixing_dependency.py +4 -4
  555. lusid/models/inflation_index_conventions.py +6 -6
  556. lusid/models/inflation_leg.py +4 -4
  557. lusid/models/inflation_linked_bond.py +4 -4
  558. lusid/models/inflation_swap.py +2 -2
  559. lusid/models/informational_error_event.py +4 -4
  560. lusid/models/informational_event.py +3 -3
  561. lusid/models/inline_valuation_request.py +2 -2
  562. lusid/models/inline_valuations_reconciliation_request.py +1 -1
  563. lusid/models/input_transition.py +1 -1
  564. lusid/models/instrument.py +8 -8
  565. lusid/models/instrument_capabilities.py +3 -3
  566. lusid/models/instrument_cash_flow.py +5 -5
  567. lusid/models/instrument_definition.py +2 -2
  568. lusid/models/instrument_definition_format.py +4 -4
  569. lusid/models/instrument_entity.py +7 -7
  570. lusid/models/instrument_event.py +2 -2
  571. lusid/models/instrument_event_configuration.py +1 -1
  572. lusid/models/instrument_event_holder.py +7 -21
  573. lusid/models/instrument_event_instruction.py +6 -6
  574. lusid/models/instrument_event_instruction_request.py +5 -5
  575. lusid/models/instrument_event_instructions_response.py +1 -1
  576. lusid/models/instrument_id_type_descriptor.py +3 -3
  577. lusid/models/instrument_id_value.py +2 -2
  578. lusid/models/instrument_leg.py +2 -2
  579. lusid/models/instrument_list.py +2 -2
  580. lusid/models/instrument_list_compliance_parameter.py +2 -2
  581. lusid/models/instrument_match.py +1 -1
  582. lusid/models/instrument_models.py +2 -2
  583. lusid/models/instrument_payment_diary.py +5 -5
  584. lusid/models/instrument_payment_diary_leg.py +2 -2
  585. lusid/models/instrument_payment_diary_row.py +4 -4
  586. lusid/models/instrument_properties.py +2 -2
  587. lusid/models/instrument_resolution_detail.py +3 -23
  588. lusid/models/instrument_search_property.py +3 -3
  589. lusid/models/interest_rate_swap.py +3 -3
  590. lusid/models/interest_rate_swaption.py +4 -4
  591. lusid/models/intermediate_compliance_step.py +3 -3
  592. lusid/models/intermediate_compliance_step_request.py +3 -10
  593. lusid/models/intermediate_securities_distribution_event.py +3 -3
  594. lusid/models/ir_vol_cube_data.py +3 -3
  595. lusid/models/ir_vol_dependency.py +4 -4
  596. lusid/models/is_business_day_response.py +1 -1
  597. lusid/models/journal_entry_line.py +18 -18
  598. lusid/models/journal_entry_line_share_class_breakdown.py +2 -2
  599. lusid/models/journal_entry_lines_query_parameters.py +3 -13
  600. lusid/models/label_value_set.py +1 -1
  601. lusid/models/lapse_election.py +2 -2
  602. lusid/models/leg_definition.py +7 -7
  603. lusid/models/legal_entity.py +5 -5
  604. lusid/models/level_step.py +1 -1
  605. lusid/models/life_cycle_event_lineage.py +6 -6
  606. lusid/models/life_cycle_event_value.py +2 -2
  607. lusid/models/lineage_member.py +5 -5
  608. lusid/models/link.py +5 -5
  609. lusid/models/list_aggregation_reconciliation.py +1 -1
  610. lusid/models/list_aggregation_response.py +3 -3
  611. lusid/models/list_complex_market_data_with_meta_data_response.py +2 -2
  612. lusid/models/loan_facility.py +4 -4
  613. lusid/models/loan_interest_repayment_event.py +3 -3
  614. lusid/models/loan_period.py +1 -1
  615. lusid/models/loan_principal_repayment_event.py +3 -3
  616. lusid/models/lock_period_diary_entry_request.py +2 -12
  617. lusid/models/lusid_instrument.py +2 -2
  618. lusid/models/lusid_problem_details.py +6 -6
  619. lusid/models/lusid_trade_ticket.py +10 -20
  620. lusid/models/lusid_unique_id.py +3 -3
  621. lusid/models/lusid_validation_problem_details.py +6 -6
  622. lusid/models/mapped_string.py +4 -4
  623. lusid/models/mapping.py +5 -26
  624. lusid/models/mapping_rule.py +4 -4
  625. lusid/models/mark_to_market_conventions.py +2 -2
  626. lusid/models/market_context.py +1 -1
  627. lusid/models/market_context_suppliers.py +6 -6
  628. lusid/models/market_data_key_rule.py +10 -17
  629. lusid/models/market_data_options.py +2 -2
  630. lusid/models/market_data_overrides.py +1 -1
  631. lusid/models/market_data_specific_rule.py +10 -17
  632. lusid/models/market_options.py +6 -33
  633. lusid/models/market_quote.py +2 -2
  634. lusid/models/mastered_instrument.py +8 -8
  635. lusid/models/match_criterion.py +2 -2
  636. lusid/models/maturity_event.py +2 -2
  637. lusid/models/mbs_coupon_event.py +3 -3
  638. lusid/models/mbs_interest_deferral_event.py +3 -3
  639. lusid/models/mbs_interest_shortfall_event.py +3 -3
  640. lusid/models/mbs_principal_event.py +3 -3
  641. lusid/models/mbs_principal_write_off_event.py +3 -3
  642. lusid/models/membership.py +4 -4
  643. lusid/models/membership_and_status.py +5 -5
  644. lusid/models/merger_event.py +3 -3
  645. lusid/models/metric_value.py +2 -2
  646. lusid/models/model_options.py +2 -2
  647. lusid/models/model_property.py +2 -2
  648. lusid/models/model_schema.py +3 -3
  649. lusid/models/model_selection.py +3 -3
  650. lusid/models/move_orders_to_different_blocks_request.py +1 -1
  651. lusid/models/moved_order_to_different_block_response.py +1 -1
  652. lusid/models/multi_currency_amounts.py +1 -1
  653. lusid/models/new_instrument.py +4 -4
  654. lusid/models/next_value_in_sequence_response.py +1 -1
  655. lusid/models/opaque_dependency.py +2 -2
  656. lusid/models/opaque_market_data.py +6 -6
  657. lusid/models/opaque_model_options.py +2 -2
  658. lusid/models/open_event.py +2 -2
  659. lusid/models/operation.py +4 -4
  660. lusid/models/option_entry.py +1 -1
  661. lusid/models/option_exercise_cash_event.py +6 -6
  662. lusid/models/option_exercise_election.py +2 -2
  663. lusid/models/option_exercise_physical_event.py +6 -6
  664. lusid/models/optionality_schedule.py +4 -4
  665. lusid/models/order.py +7 -7
  666. lusid/models/order_by_spec.py +3 -3
  667. lusid/models/order_flow_configuration.py +2 -2
  668. lusid/models/order_graph_block.py +4 -4
  669. lusid/models/order_graph_block_allocation_detail.py +1 -1
  670. lusid/models/order_graph_block_allocation_synopsis.py +1 -1
  671. lusid/models/order_graph_block_execution_detail.py +1 -1
  672. lusid/models/order_graph_block_execution_synopsis.py +1 -1
  673. lusid/models/order_graph_block_order_detail.py +5 -5
  674. lusid/models/order_graph_block_order_synopsis.py +1 -1
  675. lusid/models/order_graph_block_placement_detail.py +1 -1
  676. lusid/models/order_graph_block_placement_synopsis.py +1 -1
  677. lusid/models/order_graph_block_transaction_detail.py +2 -2
  678. lusid/models/order_graph_block_transaction_synopsis.py +1 -1
  679. lusid/models/order_graph_placement.py +2 -2
  680. lusid/models/order_graph_placement_allocation_detail.py +1 -1
  681. lusid/models/order_graph_placement_allocation_synopsis.py +1 -1
  682. lusid/models/order_graph_placement_child_placement_detail.py +1 -1
  683. lusid/models/order_graph_placement_execution_detail.py +1 -1
  684. lusid/models/order_graph_placement_execution_synopsis.py +1 -1
  685. lusid/models/order_graph_placement_order_detail.py +1 -1
  686. lusid/models/order_graph_placement_order_synopsis.py +1 -1
  687. lusid/models/order_graph_placement_placement_synopsis.py +1 -1
  688. lusid/models/order_instruction.py +3 -3
  689. lusid/models/order_instruction_request.py +1 -1
  690. lusid/models/order_instruction_set_request.py +1 -1
  691. lusid/models/order_request.py +5 -5
  692. lusid/models/order_set_request.py +1 -1
  693. lusid/models/order_update_request.py +1 -1
  694. lusid/models/otc_confirmation.py +1 -1
  695. lusid/models/output_transaction.py +13 -13
  696. lusid/models/output_transition.py +3 -3
  697. lusid/models/package.py +1 -1
  698. lusid/models/package_request.py +1 -1
  699. lusid/models/package_set_request.py +1 -1
  700. lusid/models/paged_resource_list_of_abor.py +4 -4
  701. lusid/models/paged_resource_list_of_abor_configuration.py +4 -4
  702. lusid/models/paged_resource_list_of_account.py +4 -4
  703. lusid/models/paged_resource_list_of_address_key_definition.py +4 -4
  704. lusid/models/paged_resource_list_of_allocation.py +4 -4
  705. lusid/models/paged_resource_list_of_amortisation_rule_set.py +4 -4
  706. lusid/models/paged_resource_list_of_block.py +4 -4
  707. lusid/models/paged_resource_list_of_calendar.py +4 -4
  708. lusid/models/paged_resource_list_of_chart_of_accounts.py +4 -4
  709. lusid/models/paged_resource_list_of_cleardown_module_response.py +4 -4
  710. lusid/models/paged_resource_list_of_cleardown_module_rule.py +4 -4
  711. lusid/models/paged_resource_list_of_closed_period.py +4 -4
  712. lusid/models/paged_resource_list_of_compliance_rule_response.py +4 -4
  713. lusid/models/paged_resource_list_of_compliance_run_info_v2.py +4 -4
  714. lusid/models/paged_resource_list_of_compliance_template.py +4 -4
  715. lusid/models/paged_resource_list_of_corporate_action_source.py +4 -4
  716. lusid/models/paged_resource_list_of_custodian_account.py +4 -4
  717. lusid/models/paged_resource_list_of_custom_entity_definition.py +4 -4
  718. lusid/models/paged_resource_list_of_custom_entity_response.py +4 -4
  719. lusid/models/paged_resource_list_of_custom_entity_type.py +4 -4
  720. lusid/models/paged_resource_list_of_cut_label_definition.py +4 -4
  721. lusid/models/paged_resource_list_of_data_type_summary.py +4 -4
  722. lusid/models/paged_resource_list_of_dialect_id.py +4 -4
  723. lusid/models/paged_resource_list_of_diary_entry.py +4 -4
  724. lusid/models/paged_resource_list_of_execution.py +4 -4
  725. lusid/models/paged_resource_list_of_fee.py +4 -4
  726. lusid/models/paged_resource_list_of_fee_type.py +4 -4
  727. lusid/models/paged_resource_list_of_fund.py +4 -4
  728. lusid/models/paged_resource_list_of_fund_configuration.py +4 -4
  729. lusid/models/paged_resource_list_of_general_ledger_profile_response.py +4 -4
  730. lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +4 -4
  731. lusid/models/paged_resource_list_of_group_reconciliation_comparison_ruleset.py +4 -4
  732. lusid/models/paged_resource_list_of_group_reconciliation_definition.py +4 -4
  733. lusid/models/paged_resource_list_of_identifier_definition.py +4 -4
  734. lusid/models/paged_resource_list_of_instrument.py +4 -4
  735. lusid/models/paged_resource_list_of_instrument_event_holder.py +4 -4
  736. lusid/models/paged_resource_list_of_instrument_event_instruction.py +4 -4
  737. lusid/models/paged_resource_list_of_legal_entity.py +4 -4
  738. lusid/models/paged_resource_list_of_order.py +4 -4
  739. lusid/models/paged_resource_list_of_order_graph_block.py +4 -4
  740. lusid/models/paged_resource_list_of_order_graph_placement.py +4 -4
  741. lusid/models/paged_resource_list_of_order_instruction.py +4 -4
  742. lusid/models/paged_resource_list_of_package.py +4 -4
  743. lusid/models/paged_resource_list_of_participation.py +4 -4
  744. lusid/models/paged_resource_list_of_person.py +4 -4
  745. lusid/models/paged_resource_list_of_placement.py +4 -4
  746. lusid/models/paged_resource_list_of_portfolio_group.py +4 -4
  747. lusid/models/paged_resource_list_of_portfolio_group_search_result.py +4 -4
  748. lusid/models/paged_resource_list_of_portfolio_search_result.py +4 -4
  749. lusid/models/paged_resource_list_of_posting_module_response.py +4 -4
  750. lusid/models/paged_resource_list_of_posting_module_rule.py +4 -4
  751. lusid/models/paged_resource_list_of_property_definition.py +4 -4
  752. lusid/models/paged_resource_list_of_property_definition_search_result.py +4 -4
  753. lusid/models/paged_resource_list_of_reconciliation.py +4 -4
  754. lusid/models/paged_resource_list_of_reference_list_response.py +4 -4
  755. lusid/models/paged_resource_list_of_relationship_definition.py +4 -4
  756. lusid/models/paged_resource_list_of_sequence_definition.py +4 -4
  757. lusid/models/paged_resource_list_of_staged_modification.py +4 -4
  758. lusid/models/paged_resource_list_of_staged_modifications_requested_change_interval.py +4 -4
  759. lusid/models/paged_resource_list_of_staging_rule_set.py +4 -4
  760. lusid/models/paged_resource_list_of_transaction_template.py +4 -4
  761. lusid/models/paged_resource_list_of_transaction_template_specification.py +4 -4
  762. lusid/models/paged_resource_list_of_translation_script_id.py +4 -4
  763. lusid/models/paged_resource_list_of_valuation_point_overview.py +4 -4
  764. lusid/models/paged_resource_list_of_virtual_row.py +4 -4
  765. lusid/models/paged_resource_list_of_workspace.py +4 -4
  766. lusid/models/paged_resource_list_of_workspace_item.py +4 -4
  767. lusid/models/participation.py +1 -1
  768. lusid/models/participation_request.py +1 -1
  769. lusid/models/participation_set_request.py +1 -1
  770. lusid/models/percent_check_step.py +3 -3
  771. lusid/models/percent_check_step_request.py +3 -10
  772. lusid/models/performance_return.py +2 -2
  773. lusid/models/performance_returns_metric.py +5 -5
  774. lusid/models/period_diary_entries_reopened_response.py +2 -2
  775. lusid/models/perpetual_property.py +2 -2
  776. lusid/models/person.py +5 -5
  777. lusid/models/place_blocks_request.py +1 -1
  778. lusid/models/placement.py +9 -9
  779. lusid/models/placement_request.py +8 -8
  780. lusid/models/placement_set_request.py +1 -1
  781. lusid/models/placement_update_request.py +4 -4
  782. lusid/models/pnl_journal_entry_line.py +2 -2
  783. lusid/models/portfolio.py +10 -10
  784. lusid/models/portfolio_cash_flow.py +3 -3
  785. lusid/models/portfolio_cash_ladder.py +2 -2
  786. lusid/models/portfolio_details.py +7 -7
  787. lusid/models/portfolio_entity.py +7 -7
  788. lusid/models/portfolio_entity_id.py +4 -18
  789. lusid/models/portfolio_group.py +4 -4
  790. lusid/models/portfolio_group_id_compliance_parameter.py +2 -2
  791. lusid/models/portfolio_group_id_list.py +2 -2
  792. lusid/models/portfolio_group_id_list_compliance_parameter.py +2 -2
  793. lusid/models/portfolio_group_properties.py +2 -2
  794. lusid/models/portfolio_group_search_result.py +4 -4
  795. lusid/models/portfolio_holding.py +6 -6
  796. lusid/models/portfolio_id.py +2 -2
  797. lusid/models/portfolio_id_compliance_parameter.py +2 -2
  798. lusid/models/portfolio_id_list.py +2 -2
  799. lusid/models/portfolio_id_list_compliance_parameter.py +2 -2
  800. lusid/models/portfolio_properties.py +2 -2
  801. lusid/models/portfolio_reconciliation_request.py +2 -2
  802. lusid/models/portfolio_result_data_key_rule.py +8 -35
  803. lusid/models/portfolio_return_breakdown.py +2 -2
  804. lusid/models/portfolio_search_result.py +6 -6
  805. lusid/models/portfolio_trade_ticket.py +1 -1
  806. lusid/models/portfolio_without_href.py +9 -9
  807. lusid/models/portfolios_reconciliation_request.py +1 -1
  808. lusid/models/posting_module_details.py +4 -21
  809. lusid/models/posting_module_request.py +4 -28
  810. lusid/models/posting_module_response.py +6 -16
  811. lusid/models/posting_module_rule.py +4 -25
  812. lusid/models/posting_module_rules_updated_response.py +2 -2
  813. lusid/models/pre_trade_configuration.py +2 -2
  814. lusid/models/premium.py +2 -2
  815. lusid/models/previous_fund_valuation_point_data.py +1 -1
  816. lusid/models/previous_nav.py +1 -1
  817. lusid/models/previous_share_class_breakdown.py +1 -1
  818. lusid/models/pricing_context.py +2 -2
  819. lusid/models/pricing_options.py +2 -2
  820. lusid/models/processed_command.py +3 -3
  821. lusid/models/property_definition.py +16 -16
  822. lusid/models/property_definition_entity.py +7 -7
  823. lusid/models/property_definition_search_result.py +15 -15
  824. lusid/models/property_filter.py +4 -4
  825. lusid/models/property_interval.py +2 -2
  826. lusid/models/property_key_compliance_parameter.py +3 -3
  827. lusid/models/property_key_list_compliance_parameter.py +2 -2
  828. lusid/models/property_list.py +2 -2
  829. lusid/models/property_list_compliance_parameter.py +2 -2
  830. lusid/models/property_schema.py +2 -2
  831. lusid/models/property_value.py +2 -2
  832. lusid/models/property_value_equals.py +4 -4
  833. lusid/models/property_value_in.py +3 -3
  834. lusid/models/protection_payout_cash_flow_event.py +3 -3
  835. lusid/models/quantity_instructed.py +2 -2
  836. lusid/models/query_applicable_instrument_events_request.py +1 -1
  837. lusid/models/query_bucketed_cash_flows_request.py +5 -15
  838. lusid/models/query_cash_flows_request.py +1 -1
  839. lusid/models/query_instrument_events_request.py +2 -12
  840. lusid/models/query_trade_tickets_request.py +1 -1
  841. lusid/models/queryable_key.py +9 -9
  842. lusid/models/quote.py +4 -4
  843. lusid/models/quote_access_metadata_rule.py +1 -1
  844. lusid/models/quote_access_metadata_rule_id.py +7 -27
  845. lusid/models/quote_dependency.py +4 -4
  846. lusid/models/quote_id.py +2 -2
  847. lusid/models/quote_series_id.py +7 -7
  848. lusid/models/raw_vendor_event.py +3 -3
  849. lusid/models/re_open_period_diary_entry_request.py +2 -12
  850. lusid/models/realised_gain_loss.py +3 -3
  851. lusid/models/recipe_block.py +3 -3
  852. lusid/models/recipe_composer.py +3 -17
  853. lusid/models/recipe_value.py +3 -3
  854. lusid/models/recombine_step.py +3 -3
  855. lusid/models/recommended_sort_by.py +3 -3
  856. lusid/models/reconcile_date_time_rule.py +3 -3
  857. lusid/models/reconcile_numeric_rule.py +3 -3
  858. lusid/models/reconcile_string_rule.py +3 -3
  859. lusid/models/reconciled_transaction.py +1 -1
  860. lusid/models/reconciliation.py +4 -4
  861. lusid/models/reconciliation_break.py +3 -3
  862. lusid/models/reconciliation_configuration.py +1 -1
  863. lusid/models/reconciliation_id.py +2 -2
  864. lusid/models/reconciliation_left_right_address_key_pair.py +3 -3
  865. lusid/models/reconciliation_line.py +1 -1
  866. lusid/models/reconciliation_request.py +1 -1
  867. lusid/models/reconciliation_response.py +1 -1
  868. lusid/models/reconciliation_rule.py +2 -2
  869. lusid/models/reconciliation_side_configuration.py +2 -2
  870. lusid/models/reconciliation_transactions.py +1 -1
  871. lusid/models/reference_data.py +1 -1
  872. lusid/models/reference_instrument.py +5 -5
  873. lusid/models/reference_list.py +2 -2
  874. lusid/models/reference_list_request.py +3 -3
  875. lusid/models/reference_list_response.py +3 -3
  876. lusid/models/reference_portfolio_constituent.py +4 -4
  877. lusid/models/reference_portfolio_constituent_request.py +2 -2
  878. lusid/models/related_entity.py +5 -5
  879. lusid/models/relation.py +3 -3
  880. lusid/models/relation_definition.py +8 -8
  881. lusid/models/relationship.py +3 -3
  882. lusid/models/relationship_definition.py +8 -29
  883. lusid/models/relative_date_offset.py +3 -3
  884. lusid/models/repo.py +4 -4
  885. lusid/models/requested_changes.py +1 -1
  886. lusid/models/reset_event.py +4 -4
  887. lusid/models/resource_id.py +3 -3
  888. lusid/models/resource_list_of_access_controlled_resource.py +4 -4
  889. lusid/models/resource_list_of_access_metadata_value_of.py +4 -4
  890. lusid/models/resource_list_of_address_key_definition.py +4 -4
  891. lusid/models/resource_list_of_aggregated_return.py +4 -4
  892. lusid/models/resource_list_of_aggregation_query.py +4 -4
  893. lusid/models/resource_list_of_allocation.py +4 -4
  894. lusid/models/resource_list_of_applicable_instrument_event.py +4 -4
  895. lusid/models/resource_list_of_block.py +4 -4
  896. lusid/models/resource_list_of_block_and_orders.py +4 -4
  897. lusid/models/resource_list_of_calendar_date.py +4 -4
  898. lusid/models/resource_list_of_change.py +4 -4
  899. lusid/models/resource_list_of_change_history.py +4 -4
  900. lusid/models/resource_list_of_change_interval.py +4 -4
  901. lusid/models/resource_list_of_change_interval_with_order_management_detail.py +4 -4
  902. lusid/models/resource_list_of_compliance_breached_order_info.py +4 -4
  903. lusid/models/resource_list_of_compliance_rule.py +4 -4
  904. lusid/models/resource_list_of_compliance_rule_result.py +4 -4
  905. lusid/models/resource_list_of_compliance_run_info.py +4 -4
  906. lusid/models/resource_list_of_constituents_adjustment_header.py +4 -4
  907. lusid/models/resource_list_of_corporate_action.py +4 -4
  908. lusid/models/resource_list_of_data_model_summary.py +4 -4
  909. lusid/models/resource_list_of_data_type.py +4 -4
  910. lusid/models/resource_list_of_execution.py +4 -4
  911. lusid/models/resource_list_of_fee_rule.py +4 -4
  912. lusid/models/resource_list_of_get_cds_flow_conventions_response.py +4 -4
  913. lusid/models/resource_list_of_get_counterparty_agreement_response.py +4 -4
  914. lusid/models/resource_list_of_get_credit_support_annex_response.py +4 -4
  915. lusid/models/resource_list_of_get_flow_conventions_response.py +4 -4
  916. lusid/models/resource_list_of_get_index_convention_response.py +4 -4
  917. lusid/models/resource_list_of_get_recipe_composer_response.py +4 -4
  918. lusid/models/resource_list_of_get_recipe_response.py +4 -4
  919. lusid/models/resource_list_of_holdings_adjustment_header.py +4 -4
  920. lusid/models/resource_list_of_i_unit_definition_dto.py +4 -4
  921. lusid/models/resource_list_of_instrument_cash_flow.py +4 -4
  922. lusid/models/resource_list_of_instrument_event_holder.py +4 -4
  923. lusid/models/resource_list_of_instrument_id_type_descriptor.py +4 -4
  924. lusid/models/resource_list_of_legal_entity.py +4 -4
  925. lusid/models/resource_list_of_list_complex_market_data_with_meta_data_response.py +4 -4
  926. lusid/models/resource_list_of_mapping.py +4 -4
  927. lusid/models/resource_list_of_moved_order_to_different_block_response.py +4 -4
  928. lusid/models/resource_list_of_order.py +4 -4
  929. lusid/models/resource_list_of_order_instruction.py +4 -4
  930. lusid/models/resource_list_of_output_transaction.py +4 -4
  931. lusid/models/resource_list_of_package.py +4 -4
  932. lusid/models/resource_list_of_participation.py +4 -4
  933. lusid/models/resource_list_of_performance_return.py +4 -4
  934. lusid/models/resource_list_of_person.py +4 -4
  935. lusid/models/resource_list_of_placement.py +4 -4
  936. lusid/models/resource_list_of_portfolio.py +4 -4
  937. lusid/models/resource_list_of_portfolio_cash_flow.py +4 -4
  938. lusid/models/resource_list_of_portfolio_cash_ladder.py +4 -4
  939. lusid/models/resource_list_of_portfolio_trade_ticket.py +4 -4
  940. lusid/models/resource_list_of_processed_command.py +4 -4
  941. lusid/models/resource_list_of_property.py +4 -4
  942. lusid/models/resource_list_of_property_definition.py +4 -4
  943. lusid/models/resource_list_of_property_interval.py +4 -4
  944. lusid/models/resource_list_of_queryable_key.py +4 -4
  945. lusid/models/resource_list_of_quote.py +4 -4
  946. lusid/models/resource_list_of_quote_access_metadata_rule.py +4 -4
  947. lusid/models/resource_list_of_reconciliation_break.py +4 -4
  948. lusid/models/resource_list_of_relation.py +4 -4
  949. lusid/models/resource_list_of_relationship.py +4 -4
  950. lusid/models/resource_list_of_scope_definition.py +4 -4
  951. lusid/models/resource_list_of_side_definition.py +4 -4
  952. lusid/models/resource_list_of_string.py +4 -4
  953. lusid/models/resource_list_of_tax_rule_set.py +4 -4
  954. lusid/models/resource_list_of_transaction.py +4 -4
  955. lusid/models/resource_list_of_transaction_type.py +4 -4
  956. lusid/models/resource_list_of_value_type.py +4 -4
  957. lusid/models/response_meta_data.py +4 -4
  958. lusid/models/result_data_key_rule.py +8 -15
  959. lusid/models/result_data_schema.py +1 -1
  960. lusid/models/result_key_rule.py +2 -2
  961. lusid/models/result_value.py +2 -2
  962. lusid/models/result_value0_d.py +3 -3
  963. lusid/models/result_value_bool.py +2 -2
  964. lusid/models/result_value_currency.py +3 -3
  965. lusid/models/result_value_date_time_offset.py +2 -2
  966. lusid/models/result_value_decimal.py +2 -2
  967. lusid/models/result_value_dictionary.py +2 -2
  968. lusid/models/result_value_int.py +2 -2
  969. lusid/models/result_value_string.py +3 -3
  970. lusid/models/return_zero_pv_options.py +1 -1
  971. lusid/models/reverse_stock_split_event.py +3 -3
  972. lusid/models/rounding_configuration.py +1 -1
  973. lusid/models/rounding_configuration_component.py +2 -2
  974. lusid/models/rounding_convention.py +3 -3
  975. lusid/models/rules_interval.py +1 -1
  976. lusid/models/schedule.py +2 -2
  977. lusid/models/scope_definition.py +2 -2
  978. lusid/models/scrip_dividend_event.py +3 -3
  979. lusid/models/script_map_reference.py +4 -25
  980. lusid/models/security_election.py +2 -2
  981. lusid/models/security_offer_election.py +2 -2
  982. lusid/models/sequence_definition.py +2 -2
  983. lusid/models/set_amortisation_rules_request.py +1 -1
  984. lusid/models/set_legal_entity_identifiers_request.py +1 -1
  985. lusid/models/set_legal_entity_properties_request.py +1 -1
  986. lusid/models/set_person_identifiers_request.py +1 -1
  987. lusid/models/set_person_properties_request.py +1 -1
  988. lusid/models/set_share_class_instruments_request.py +1 -1
  989. lusid/models/set_transaction_configuration_alias.py +5 -12
  990. lusid/models/set_transaction_configuration_source_request.py +1 -1
  991. lusid/models/settlement_cycle.py +1 -1
  992. lusid/models/settlement_schedule.py +2 -2
  993. lusid/models/share_class_amount.py +1 -1
  994. lusid/models/share_class_breakdown.py +1 -1
  995. lusid/models/share_class_data.py +1 -1
  996. lusid/models/share_class_dealing_breakdown.py +1 -1
  997. lusid/models/share_class_details.py +5 -35
  998. lusid/models/share_class_pnl_breakdown.py +1 -1
  999. lusid/models/side_configuration_data.py +7 -7
  1000. lusid/models/side_configuration_data_request.py +7 -7
  1001. lusid/models/side_definition.py +9 -9
  1002. lusid/models/side_definition_request.py +8 -8
  1003. lusid/models/sides_definition_request.py +2 -2
  1004. lusid/models/simple_cash_flow_loan.py +3 -3
  1005. lusid/models/simple_instrument.py +5 -5
  1006. lusid/models/simple_rounding_convention.py +2 -2
  1007. lusid/models/specific_holding_pricing_info.py +2 -2
  1008. lusid/models/spin_off_event.py +3 -3
  1009. lusid/models/staged_modification.py +10 -10
  1010. lusid/models/staged_modification_decision.py +5 -5
  1011. lusid/models/staged_modification_decision_request.py +3 -3
  1012. lusid/models/staged_modification_effective_range.py +1 -1
  1013. lusid/models/staged_modification_staging_rule.py +3 -3
  1014. lusid/models/staged_modifications_entity_hrefs.py +4 -4
  1015. lusid/models/staged_modifications_info.py +2 -2
  1016. lusid/models/staged_modifications_requested_change_interval.py +3 -3
  1017. lusid/models/staging_rule.py +4 -4
  1018. lusid/models/staging_rule_approval_criteria.py +2 -2
  1019. lusid/models/staging_rule_match_criteria.py +3 -3
  1020. lusid/models/staging_rule_set.py +6 -6
  1021. lusid/models/step_schedule.py +4 -4
  1022. lusid/models/stock_dividend_event.py +3 -3
  1023. lusid/models/stock_split_event.py +3 -3
  1024. lusid/models/strategy.py +2 -2
  1025. lusid/models/string_compliance_parameter.py +3 -3
  1026. lusid/models/string_list.py +2 -2
  1027. lusid/models/string_list_compliance_parameter.py +2 -2
  1028. lusid/models/structured_result_data.py +5 -5
  1029. lusid/models/structured_result_data_id.py +5 -22
  1030. lusid/models/sub_holding_key_value_equals.py +4 -4
  1031. lusid/models/swap_cash_flow_event.py +3 -3
  1032. lusid/models/swap_principal_event.py +3 -3
  1033. lusid/models/target_tax_lot.py +1 -1
  1034. lusid/models/target_tax_lot_request.py +1 -1
  1035. lusid/models/tax_rule.py +3 -17
  1036. lusid/models/tax_rule_set.py +4 -18
  1037. lusid/models/template_field.py +6 -6
  1038. lusid/models/tender_event.py +3 -3
  1039. lusid/models/term_deposit.py +3 -3
  1040. lusid/models/term_deposit_interest_event.py +3 -3
  1041. lusid/models/term_deposit_principal_event.py +3 -3
  1042. lusid/models/timeline.py +4 -4
  1043. lusid/models/total_return_swap.py +2 -2
  1044. lusid/models/touch.py +4 -4
  1045. lusid/models/trade_ticket.py +2 -2
  1046. lusid/models/trading_conventions.py +1 -1
  1047. lusid/models/transaction.py +10 -10
  1048. lusid/models/transaction_configuration_data.py +1 -1
  1049. lusid/models/transaction_configuration_data_request.py +1 -1
  1050. lusid/models/transaction_configuration_movement_data.py +4 -4
  1051. lusid/models/transaction_configuration_movement_data_request.py +4 -4
  1052. lusid/models/transaction_configuration_type_alias.py +7 -17
  1053. lusid/models/transaction_currency_and_amount.py +3 -3
  1054. lusid/models/transaction_date_windows.py +3 -17
  1055. lusid/models/transaction_diagnostics.py +2 -2
  1056. lusid/models/transaction_field_map.py +10 -10
  1057. lusid/models/transaction_price.py +2 -2
  1058. lusid/models/transaction_price_and_type.py +3 -3
  1059. lusid/models/transaction_property_map.py +3 -3
  1060. lusid/models/transaction_property_mapping.py +3 -3
  1061. lusid/models/transaction_property_mapping_request.py +3 -3
  1062. lusid/models/transaction_query_parameters.py +4 -4
  1063. lusid/models/transaction_reconciliation_request.py +1 -1
  1064. lusid/models/transaction_reconciliation_request_v2.py +1 -1
  1065. lusid/models/transaction_request.py +9 -9
  1066. lusid/models/transaction_set_configuration_data.py +1 -1
  1067. lusid/models/transaction_set_configuration_data_request.py +1 -1
  1068. lusid/models/transaction_template.py +5 -5
  1069. lusid/models/transaction_template_request.py +2 -2
  1070. lusid/models/transaction_template_specification.py +2 -2
  1071. lusid/models/transaction_type.py +1 -1
  1072. lusid/models/transaction_type_alias.py +5 -19
  1073. lusid/models/transaction_type_calculation.py +4 -4
  1074. lusid/models/transaction_type_details.py +4 -4
  1075. lusid/models/transaction_type_movement.py +6 -33
  1076. lusid/models/transaction_type_property_mapping.py +5 -25
  1077. lusid/models/transaction_type_request.py +1 -1
  1078. lusid/models/transactions_reconciliations_response.py +1 -1
  1079. lusid/models/transition_event.py +2 -2
  1080. lusid/models/translate_entities_inlined_request.py +2 -2
  1081. lusid/models/translate_entities_request.py +1 -1
  1082. lusid/models/translate_entities_response.py +1 -1
  1083. lusid/models/translate_instrument_definitions_request.py +2 -9
  1084. lusid/models/translate_instrument_definitions_response.py +2 -2
  1085. lusid/models/translate_trade_ticket_request.py +2 -9
  1086. lusid/models/translate_trade_tickets_response.py +2 -2
  1087. lusid/models/translation_context.py +1 -1
  1088. lusid/models/translation_input.py +2 -2
  1089. lusid/models/translation_result.py +2 -2
  1090. lusid/models/translation_script.py +2 -2
  1091. lusid/models/translation_script_id.py +4 -25
  1092. lusid/models/trial_balance.py +5 -5
  1093. lusid/models/trial_balance_query_parameters.py +3 -13
  1094. lusid/models/trigger_event.py +4 -4
  1095. lusid/models/typed_resource_id.py +4 -25
  1096. lusid/models/unitisation_data.py +1 -1
  1097. lusid/models/units_ratio.py +1 -1
  1098. lusid/models/update_amortisation_rule_set_details_request.py +3 -20
  1099. lusid/models/update_calendar_request.py +2 -9
  1100. lusid/models/update_compliance_template_request.py +3 -17
  1101. lusid/models/update_custom_data_model_request.py +4 -28
  1102. lusid/models/update_custom_entity_definition_request.py +3 -17
  1103. lusid/models/update_custom_entity_type_request.py +3 -17
  1104. lusid/models/update_cut_label_definition_request.py +4 -21
  1105. lusid/models/update_data_type_request.py +3 -23
  1106. lusid/models/update_deposit_amount_event.py +2 -2
  1107. lusid/models/update_derived_property_definition_request.py +4 -4
  1108. lusid/models/update_fee_type_request.py +3 -13
  1109. lusid/models/update_group_reconciliation_comparison_ruleset_request.py +3 -3
  1110. lusid/models/update_group_reconciliation_definition_request.py +3 -3
  1111. lusid/models/update_identifier_definition_request.py +4 -34
  1112. lusid/models/update_instrument_identifier_request.py +4 -4
  1113. lusid/models/update_orders_response.py +2 -2
  1114. lusid/models/update_placements_response.py +2 -2
  1115. lusid/models/update_portfolio_group_request.py +3 -3
  1116. lusid/models/update_portfolio_request.py +3 -3
  1117. lusid/models/update_property_definition_request.py +3 -3
  1118. lusid/models/update_reconciliation_request.py +3 -3
  1119. lusid/models/update_reference_data_request.py +1 -1
  1120. lusid/models/update_relationship_definition_request.py +4 -25
  1121. lusid/models/update_staging_rule_set_request.py +3 -3
  1122. lusid/models/update_tax_rule_set_request.py +3 -17
  1123. lusid/models/update_timeline_request.py +3 -3
  1124. lusid/models/update_unit_request.py +4 -34
  1125. lusid/models/upsert_cds_flow_conventions_request.py +1 -1
  1126. lusid/models/upsert_complex_market_data_request.py +1 -1
  1127. lusid/models/upsert_compliance_rule_request.py +4 -4
  1128. lusid/models/upsert_compliance_run_summary_request.py +2 -2
  1129. lusid/models/upsert_compliance_run_summary_result.py +2 -2
  1130. lusid/models/upsert_corporate_action_request.py +3 -20
  1131. lusid/models/upsert_corporate_actions_response.py +2 -2
  1132. lusid/models/upsert_counterparty_agreement_request.py +1 -1
  1133. lusid/models/upsert_credit_support_annex_request.py +1 -1
  1134. lusid/models/upsert_custom_entities_response.py +2 -2
  1135. lusid/models/upsert_custom_entity_access_metadata_request.py +1 -1
  1136. lusid/models/upsert_dialect_request.py +1 -1
  1137. lusid/models/upsert_flow_conventions_request.py +1 -1
  1138. lusid/models/upsert_index_convention_request.py +1 -1
  1139. lusid/models/upsert_instrument_event_request.py +4 -21
  1140. lusid/models/upsert_instrument_events_response.py +2 -2
  1141. lusid/models/upsert_instrument_properties_response.py +1 -1
  1142. lusid/models/upsert_instrument_property_request.py +3 -3
  1143. lusid/models/upsert_instruments_response.py +2 -2
  1144. lusid/models/upsert_legal_entities_response.py +2 -2
  1145. lusid/models/upsert_legal_entity_access_metadata_request.py +1 -1
  1146. lusid/models/upsert_legal_entity_request.py +3 -20
  1147. lusid/models/upsert_person_access_metadata_request.py +1 -1
  1148. lusid/models/upsert_person_request.py +3 -3
  1149. lusid/models/upsert_persons_response.py +1 -1
  1150. lusid/models/upsert_portfolio_access_metadata_request.py +1 -1
  1151. lusid/models/upsert_portfolio_group_access_metadata_request.py +1 -1
  1152. lusid/models/upsert_portfolio_transactions_response.py +2 -2
  1153. lusid/models/upsert_quote_access_metadata_rule_request.py +1 -1
  1154. lusid/models/upsert_quote_request.py +2 -2
  1155. lusid/models/upsert_quotes_response.py +2 -2
  1156. lusid/models/upsert_recipe_composer_request.py +1 -1
  1157. lusid/models/upsert_recipe_request.py +1 -1
  1158. lusid/models/upsert_reference_portfolio_constituent_properties_request.py +1 -1
  1159. lusid/models/upsert_reference_portfolio_constituent_properties_response.py +2 -2
  1160. lusid/models/upsert_reference_portfolio_constituents_request.py +4 -4
  1161. lusid/models/upsert_reference_portfolio_constituents_response.py +2 -2
  1162. lusid/models/upsert_result_values_data_request.py +2 -2
  1163. lusid/models/upsert_returns_response.py +2 -2
  1164. lusid/models/upsert_single_structured_data_response.py +2 -2
  1165. lusid/models/upsert_structured_data_response.py +2 -2
  1166. lusid/models/upsert_structured_result_data_request.py +1 -1
  1167. lusid/models/upsert_transaction_properties_response.py +2 -2
  1168. lusid/models/upsert_translation_script_request.py +2 -2
  1169. lusid/models/upsert_valuation_point_request.py +3 -20
  1170. lusid/models/user.py +2 -2
  1171. lusid/models/valuation_point_data_query_parameters.py +1 -1
  1172. lusid/models/valuation_point_data_request.py +2 -9
  1173. lusid/models/valuation_point_data_response.py +6 -6
  1174. lusid/models/valuation_point_overview.py +5 -5
  1175. lusid/models/valuation_point_resource_list_of_accounted_transaction.py +4 -4
  1176. lusid/models/valuation_point_resource_list_of_fund_journal_entry_line.py +4 -4
  1177. lusid/models/valuation_point_resource_list_of_pnl_journal_entry_line.py +4 -4
  1178. lusid/models/valuation_point_resource_list_of_trial_balance.py +4 -4
  1179. lusid/models/valuation_request.py +2 -2
  1180. lusid/models/valuation_schedule.py +6 -6
  1181. lusid/models/valuations_reconciliation_request.py +1 -1
  1182. lusid/models/vendor_dependency.py +3 -3
  1183. lusid/models/vendor_model_rule.py +6 -6
  1184. lusid/models/version.py +7 -7
  1185. lusid/models/version_summary_dto.py +4 -4
  1186. lusid/models/versioned_resource_list_of_a2_b_data_record.py +4 -4
  1187. lusid/models/versioned_resource_list_of_a2_b_movement_record.py +4 -4
  1188. lusid/models/versioned_resource_list_of_holding_contributor.py +4 -4
  1189. lusid/models/versioned_resource_list_of_journal_entry_line.py +4 -4
  1190. lusid/models/versioned_resource_list_of_output_transaction.py +4 -4
  1191. lusid/models/versioned_resource_list_of_portfolio_holding.py +4 -4
  1192. lusid/models/versioned_resource_list_of_transaction.py +4 -4
  1193. lusid/models/versioned_resource_list_of_trial_balance.py +4 -4
  1194. lusid/models/versioned_resource_list_with_warnings_of_portfolio_holding.py +4 -4
  1195. lusid/models/virtual_document.py +1 -1
  1196. lusid/models/virtual_document_row.py +1 -1
  1197. lusid/models/virtual_row.py +1 -1
  1198. lusid/models/warning.py +3 -3
  1199. lusid/models/weekend_mask.py +2 -9
  1200. lusid/models/weighted_instrument.py +3 -3
  1201. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +12 -12
  1202. lusid/models/weighted_instruments.py +1 -1
  1203. lusid/models/workspace.py +3 -3
  1204. lusid/models/workspace_creation_request.py +3 -10
  1205. lusid/models/workspace_item.py +5 -12
  1206. lusid/models/workspace_item_creation_request.py +5 -26
  1207. lusid/models/workspace_item_update_request.py +3 -10
  1208. lusid/models/workspace_update_request.py +2 -2
  1209. lusid/models/yield_curve_data.py +3 -3
  1210. {lusid_sdk-2.1.721.dist-info → lusid_sdk-2.1.723.dist-info}/METADATA +1 -1
  1211. lusid_sdk-2.1.723.dist-info/RECORD +1288 -0
  1212. lusid_sdk-2.1.721.dist-info/RECORD +0 -1288
  1213. {lusid_sdk-2.1.721.dist-info → lusid_sdk-2.1.723.dist-info}/WHEEL +0 -0
@@ -57,6 +57,10 @@ from lusid.exceptions import ( # noqa: F401
57
57
  )
58
58
  from lusid.extensions.configuration_options import ConfigurationOptions
59
59
 
60
+ # ensure templated type usages are imported
61
+ from pydantic.v1 import Field, StrictStr
62
+ from typing import Optional
63
+ from typing_extensions import Annotated
60
64
 
61
65
  class InstrumentsApi:
62
66
  """NOTE: This class is auto generated by OpenAPI Generator
@@ -70,16 +74,17 @@ class InstrumentsApi:
70
74
  api_client = ApiClient.get_default()
71
75
  self.api_client = api_client
72
76
 
77
+
73
78
  @overload
74
- async def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> BatchUpsertInstrumentPropertiesResponse: # noqa: E501
79
+ async def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> BatchUpsertInstrumentPropertiesResponse: # noqa: E501
75
80
  ...
76
81
 
77
82
  @overload
78
- def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpsertInstrumentPropertiesResponse: # noqa: E501
83
+ def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=True, **kwargs) -> BatchUpsertInstrumentPropertiesResponse: # noqa: E501
79
84
  ...
80
85
 
81
86
  @validate_arguments
82
- def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertInstrumentPropertiesResponse, Awaitable[BatchUpsertInstrumentPropertiesResponse]]: # noqa: E501
87
+ def batch_upsert_instrument_properties(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BatchUpsertInstrumentPropertiesResponse, Awaitable[BatchUpsertInstrumentPropertiesResponse]]: # noqa: E501
83
88
  """BatchUpsertInstrumentProperties: Batch upsert instruments properties # noqa: E501
84
89
 
85
90
  Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
@@ -116,7 +121,7 @@ class InstrumentsApi:
116
121
  return self.batch_upsert_instrument_properties_with_http_info(request_body, scope, identifier_effective_at, success_mode, **kwargs) # noqa: E501
117
122
 
118
123
  @validate_arguments
119
- def batch_upsert_instrument_properties_with_http_info(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> ApiResponse: # noqa: E501
124
+ def batch_upsert_instrument_properties_with_http_info(self, request_body : Annotated[Dict[str, UpsertInstrumentPropertyRequest], Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve each instrument from the provided identifiers. Defaults to the current LUSID system datetime if not specified.")] = None, success_mode : Annotated[Optional[StrictStr], Field( description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")] = None, **kwargs) -> ApiResponse: # noqa: E501
120
125
  """BatchUpsertInstrumentProperties: Batch upsert instruments properties # noqa: E501
121
126
 
122
127
  Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
@@ -252,16 +257,17 @@ class InstrumentsApi:
252
257
  collection_formats=_collection_formats,
253
258
  _request_auth=_params.get('_request_auth'))
254
259
 
260
+
255
261
  @overload
256
- async def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field(description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> AddBusinessDaysToDateResponse: # noqa: E501
262
+ async def calculate_settlement_date(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> AddBusinessDaysToDateResponse: # noqa: E501
257
263
  ...
258
264
 
259
265
  @overload
260
- def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field(description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> AddBusinessDaysToDateResponse: # noqa: E501
266
+ def calculate_settlement_date(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> AddBusinessDaysToDateResponse: # noqa: E501
261
267
  ...
262
268
 
263
269
  @validate_arguments
264
- def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field(description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AddBusinessDaysToDateResponse, Awaitable[AddBusinessDaysToDateResponse]]: # noqa: E501
270
+ def calculate_settlement_date(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AddBusinessDaysToDateResponse, Awaitable[AddBusinessDaysToDateResponse]]: # noqa: E501
265
271
  """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
266
272
 
267
273
  Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. # noqa: E501
@@ -300,7 +306,7 @@ class InstrumentsApi:
300
306
  return self.calculate_settlement_date_with_http_info(identifier_type, identifier, transaction_date, scope, as_at, **kwargs) # noqa: E501
301
307
 
302
308
  @validate_arguments
303
- def calculate_settlement_date_with_http_info(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field(description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
309
+ def calculate_settlement_date_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
304
310
  """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
305
311
 
306
312
  Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. # noqa: E501
@@ -438,16 +444,17 @@ class InstrumentsApi:
438
444
  collection_formats=_collection_formats,
439
445
  _request_auth=_params.get('_request_auth'))
440
446
 
447
+
441
448
  @overload
442
- async def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentResponse: # noqa: E501
449
+ async def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentResponse: # noqa: E501
443
450
  ...
444
451
 
445
452
  @overload
446
- def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentResponse: # noqa: E501
453
+ def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentResponse: # noqa: E501
447
454
  ...
448
455
 
449
456
  @validate_arguments
450
- def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentResponse, Awaitable[DeleteInstrumentResponse]]: # noqa: E501
457
+ def delete_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentResponse, Awaitable[DeleteInstrumentResponse]]: # noqa: E501
451
458
  """DeleteInstrument: Soft delete a single instrument # noqa: E501
452
459
 
453
460
  Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. # noqa: E501
@@ -482,7 +489,7 @@ class InstrumentsApi:
482
489
  return self.delete_instrument_with_http_info(identifier_type, identifier, scope, **kwargs) # noqa: E501
483
490
 
484
491
  @validate_arguments
485
- def delete_instrument_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
492
+ def delete_instrument_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
486
493
  """DeleteInstrument: Soft delete a single instrument # noqa: E501
487
494
 
488
495
  Soft delete a particular instrument, as identified by a particular instrument identifier. Once deleted, an instrument is marked as inactive and can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the deleted instrument. # noqa: E501
@@ -605,16 +612,17 @@ class InstrumentsApi:
605
612
  collection_formats=_collection_formats,
606
613
  _request_auth=_params.get('_request_auth'))
607
614
 
615
+
608
616
  @overload
609
- async def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentPropertiesResponse: # noqa: E501
617
+ async def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentPropertiesResponse: # noqa: E501
610
618
  ...
611
619
 
612
620
  @overload
613
- def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentPropertiesResponse: # noqa: E501
621
+ def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentPropertiesResponse: # noqa: E501
614
622
  ...
615
623
 
616
624
  @validate_arguments
617
- def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentPropertiesResponse, Awaitable[DeleteInstrumentPropertiesResponse]]: # noqa: E501
625
+ def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentPropertiesResponse, Awaitable[DeleteInstrumentPropertiesResponse]]: # noqa: E501
618
626
  """[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties # noqa: E501
619
627
 
620
628
  Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
@@ -653,7 +661,7 @@ class InstrumentsApi:
653
661
  return self.delete_instrument_properties_with_http_info(identifier_type, identifier, request_body, effective_at, scope, **kwargs) # noqa: E501
654
662
 
655
663
  @validate_arguments
656
- def delete_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
664
+ def delete_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
657
665
  """[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties # noqa: E501
658
666
 
659
667
  Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
@@ -795,16 +803,17 @@ class InstrumentsApi:
795
803
  collection_formats=_collection_formats,
796
804
  _request_auth=_params.get('_request_auth'))
797
805
 
806
+
798
807
  @overload
799
- async def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentsResponse: # noqa: E501
808
+ async def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentsResponse: # noqa: E501
800
809
  ...
801
810
 
802
811
  @overload
803
- def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentsResponse: # noqa: E501
812
+ def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeleteInstrumentsResponse: # noqa: E501
804
813
  ...
805
814
 
806
815
  @validate_arguments
807
- def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentsResponse, Awaitable[DeleteInstrumentsResponse]]: # noqa: E501
816
+ def delete_instruments(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentsResponse, Awaitable[DeleteInstrumentsResponse]]: # noqa: E501
808
817
  """DeleteInstruments: Soft or hard delete multiple instruments # noqa: E501
809
818
 
810
819
  Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. # noqa: E501
@@ -839,7 +848,7 @@ class InstrumentsApi:
839
848
  return self.delete_instruments_with_http_info(request_body, delete_mode, scope, **kwargs) # noqa: E501
840
849
 
841
850
  @validate_arguments
842
- def delete_instruments_with_http_info(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field(description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
851
+ def delete_instruments_with_http_info(self, request_body : Annotated[conlist(StrictStr), Field(..., description="The list of lusidInstrumentId's to delete.")], delete_mode : Annotated[Optional[StrictStr], Field( description="The delete mode to use (defaults to 'Soft').")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instruments lie. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
843
852
  """DeleteInstruments: Soft or hard delete multiple instruments # noqa: E501
844
853
 
845
854
  Deletes a number of instruments identified by LusidInstrumentId. Soft deletion marks the instrument as inactive so it can no longer be referenced when creating or updating transactions or holdings. You can still query existing transactions and holdings related to the inactive instrument. In addition to the above behaviour, hard deletion: (i) completely removes all external identifiers from the instrument; (ii) marks the instrument as 'Deleted'; (iii) prepends the instrument's name with 'DELETED '; (iv) prevents the instrument from being returned in list instruments queries. Following hard deletion, an instrument may only be retrieved by making a direct get instrument request for the LusidInstrumentId. Instrument deletion cannot be undone. Please note that currency instruments cannot currently be deleted. The maximum number of instruments that this method can delete per request is 2,000. # noqa: E501
@@ -969,16 +978,17 @@ class InstrumentsApi:
969
978
  collection_formats=_collection_formats,
970
979
  _request_auth=_params.get('_request_auth'))
971
980
 
981
+
972
982
  @overload
973
- async def get_all_possible_features(self, instrument_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], **kwargs) -> Dict[str, List[str]]: # noqa: E501
983
+ async def get_all_possible_features(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], **kwargs) -> Dict[str, List[str]]: # noqa: E501
974
984
  ...
975
985
 
976
986
  @overload
977
- def get_all_possible_features(self, instrument_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], async_req: Optional[bool]=True, **kwargs) -> Dict[str, List[str]]: # noqa: E501
987
+ def get_all_possible_features(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], async_req: Optional[bool]=True, **kwargs) -> Dict[str, List[str]]: # noqa: E501
978
988
  ...
979
989
 
980
990
  @validate_arguments
981
- def get_all_possible_features(self, instrument_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[str]], Awaitable[Dict[str, List[str]]]]: # noqa: E501
991
+ def get_all_possible_features(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[str]], Awaitable[Dict[str, List[str]]]]: # noqa: E501
982
992
  """[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
983
993
 
984
994
  Provides all possible instrument features an instrument of a given type can provide. # noqa: E501
@@ -1009,7 +1019,7 @@ class InstrumentsApi:
1009
1019
  return self.get_all_possible_features_with_http_info(instrument_type, **kwargs) # noqa: E501
1010
1020
 
1011
1021
  @validate_arguments
1012
- def get_all_possible_features_with_http_info(self, instrument_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], **kwargs) -> ApiResponse: # noqa: E501
1022
+ def get_all_possible_features_with_http_info(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], **kwargs) -> ApiResponse: # noqa: E501
1013
1023
  """[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
1014
1024
 
1015
1025
  Provides all possible instrument features an instrument of a given type can provide. # noqa: E501
@@ -1120,16 +1130,17 @@ class InstrumentsApi:
1120
1130
  collection_formats=_collection_formats,
1121
1131
  _request_auth=_params.get('_request_auth'))
1122
1132
 
1133
+
1123
1134
  @overload
1124
- async def get_existing_instrument_capabilities(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> InstrumentCapabilities: # noqa: E501
1135
+ async def get_existing_instrument_capabilities(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> InstrumentCapabilities: # noqa: E501
1125
1136
  ...
1126
1137
 
1127
1138
  @overload
1128
- def get_existing_instrument_capabilities(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentCapabilities: # noqa: E501
1139
+ def get_existing_instrument_capabilities(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentCapabilities: # noqa: E501
1129
1140
  ...
1130
1141
 
1131
1142
  @validate_arguments
1132
- def get_existing_instrument_capabilities(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
1143
+ def get_existing_instrument_capabilities(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
1133
1144
  """[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1134
1145
 
1135
1146
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
@@ -1172,7 +1183,7 @@ class InstrumentsApi:
1172
1183
  return self.get_existing_instrument_capabilities_with_http_info(identifier, model, effective_at, as_at, instrument_scope, recipe_scope, recipe_code, **kwargs) # noqa: E501
1173
1184
 
1174
1185
  @validate_arguments
1175
- def get_existing_instrument_capabilities_with_http_info(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1186
+ def get_existing_instrument_capabilities_with_http_info(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1176
1187
  """[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1177
1188
 
1178
1189
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
@@ -1322,16 +1333,17 @@ class InstrumentsApi:
1322
1333
  collection_formats=_collection_formats,
1323
1334
  _request_auth=_params.get('_request_auth'))
1324
1335
 
1336
+
1325
1337
  @overload
1326
- async def get_existing_instrument_models(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> InstrumentModels: # noqa: E501
1338
+ async def get_existing_instrument_models(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> InstrumentModels: # noqa: E501
1327
1339
  ...
1328
1340
 
1329
1341
  @overload
1330
- def get_existing_instrument_models(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentModels: # noqa: E501
1342
+ def get_existing_instrument_models(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentModels: # noqa: E501
1331
1343
  ...
1332
1344
 
1333
1345
  @validate_arguments
1334
- def get_existing_instrument_models(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentModels, Awaitable[InstrumentModels]]: # noqa: E501
1346
+ def get_existing_instrument_models(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentModels, Awaitable[InstrumentModels]]: # noqa: E501
1335
1347
  """GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. # noqa: E501
1336
1348
 
1337
1349
  Get the supported pricing models of a single instrument. # noqa: E501
@@ -1372,7 +1384,7 @@ class InstrumentsApi:
1372
1384
  return self.get_existing_instrument_models_with_http_info(identifier, effective_at, as_at, instrument_scope, recipe_scope, recipe_code, **kwargs) # noqa: E501
1373
1385
 
1374
1386
  @validate_arguments
1375
- def get_existing_instrument_models_with_http_info(self, identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1387
+ def get_existing_instrument_models_with_http_info(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1376
1388
  """GetExistingInstrumentModels: Retrieve supported pricing models for an existing instrument identified by LUID. # noqa: E501
1377
1389
 
1378
1390
  Get the supported pricing models of a single instrument. # noqa: E501
@@ -1516,16 +1528,17 @@ class InstrumentsApi:
1516
1528
  collection_formats=_collection_formats,
1517
1529
  _request_auth=_params.get('_request_auth'))
1518
1530
 
1531
+
1519
1532
  @overload
1520
- async def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> Instrument: # noqa: E501
1533
+ async def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> Instrument: # noqa: E501
1521
1534
  ...
1522
1535
 
1523
1536
  @overload
1524
- def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> Instrument: # noqa: E501
1537
+ def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> Instrument: # noqa: E501
1525
1538
  ...
1526
1539
 
1527
1540
  @validate_arguments
1528
- def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Instrument, Awaitable[Instrument]]: # noqa: E501
1541
+ def get_instrument(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Instrument, Awaitable[Instrument]]: # noqa: E501
1529
1542
  """GetInstrument: Get instrument # noqa: E501
1530
1543
 
1531
1544
  Retrieve the definition of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -1568,7 +1581,7 @@ class InstrumentsApi:
1568
1581
  return self.get_instrument_with_http_info(identifier_type, identifier, effective_at, as_at, property_keys, scope, relationship_definition_ids, **kwargs) # noqa: E501
1569
1582
 
1570
1583
  @validate_arguments
1571
- def get_instrument_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1584
+ def get_instrument_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument. Defaults to returning the latest version if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto the instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1572
1585
  """GetInstrument: Get instrument # noqa: E501
1573
1586
 
1574
1587
  Retrieve the definition of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -1720,6 +1733,7 @@ class InstrumentsApi:
1720
1733
  collection_formats=_collection_formats,
1721
1734
  _request_auth=_params.get('_request_auth'))
1722
1735
 
1736
+
1723
1737
  @overload
1724
1738
  async def get_instrument_identifier_types(self, **kwargs) -> ResourceListOfInstrumentIdTypeDescriptor: # noqa: E501
1725
1739
  ...
@@ -1862,16 +1876,17 @@ class InstrumentsApi:
1862
1876
  collection_formats=_collection_formats,
1863
1877
  _request_auth=_params.get('_request_auth'))
1864
1878
 
1879
+
1865
1880
  @overload
1866
- async def get_instrument_payment_diary(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> InstrumentPaymentDiary: # noqa: E501
1881
+ async def get_instrument_payment_diary(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> InstrumentPaymentDiary: # noqa: E501
1867
1882
  ...
1868
1883
 
1869
1884
  @overload
1870
- def get_instrument_payment_diary(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentPaymentDiary: # noqa: E501
1885
+ def get_instrument_payment_diary(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentPaymentDiary: # noqa: E501
1871
1886
  ...
1872
1887
 
1873
1888
  @validate_arguments
1874
- def get_instrument_payment_diary(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentPaymentDiary, Awaitable[InstrumentPaymentDiary]]: # noqa: E501
1889
+ def get_instrument_payment_diary(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentPaymentDiary, Awaitable[InstrumentPaymentDiary]]: # noqa: E501
1875
1890
  """[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1876
1891
 
1877
1892
  Get the payment diary of a single instrument. # noqa: E501
@@ -1914,7 +1929,7 @@ class InstrumentsApi:
1914
1929
  return self.get_instrument_payment_diary_with_http_info(identifier_type, identifier, recipe_scope, recipe_code, effective_at, as_at, scope, **kwargs) # noqa: E501
1915
1930
 
1916
1931
  @validate_arguments
1917
- def get_instrument_payment_diary_with_http_info(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1932
+ def get_instrument_payment_diary_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1918
1933
  """[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1919
1934
 
1920
1935
  Get the payment diary of a single instrument. # noqa: E501
@@ -2064,16 +2079,17 @@ class InstrumentsApi:
2064
2079
  collection_formats=_collection_formats,
2065
2080
  _request_auth=_params.get('_request_auth'))
2066
2081
 
2082
+
2067
2083
  @overload
2068
- async def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> InstrumentProperties: # noqa: E501
2084
+ async def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> InstrumentProperties: # noqa: E501
2069
2085
  ...
2070
2086
 
2071
2087
  @overload
2072
- def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentProperties: # noqa: E501
2088
+ def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentProperties: # noqa: E501
2073
2089
  ...
2074
2090
 
2075
2091
  @validate_arguments
2076
- def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentProperties, Awaitable[InstrumentProperties]]: # noqa: E501
2092
+ def get_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentProperties, Awaitable[InstrumentProperties]]: # noqa: E501
2077
2093
  """GetInstrumentProperties: Get instrument properties # noqa: E501
2078
2094
 
2079
2095
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -2112,7 +2128,7 @@ class InstrumentsApi:
2112
2128
  return self.get_instrument_properties_with_http_info(identifier_type, identifier, effective_at, as_at, scope, **kwargs) # noqa: E501
2113
2129
 
2114
2130
  @validate_arguments
2115
- def get_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2131
+ def get_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2116
2132
  """GetInstrumentProperties: Get instrument properties # noqa: E501
2117
2133
 
2118
2134
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -2250,16 +2266,17 @@ class InstrumentsApi:
2250
2266
  collection_formats=_collection_formats,
2251
2267
  _request_auth=_params.get('_request_auth'))
2252
2268
 
2269
+
2253
2270
  @overload
2254
- async def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
2271
+ async def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
2255
2272
  ...
2256
2273
 
2257
2274
  @overload
2258
- def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
2275
+ def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
2259
2276
  ...
2260
2277
 
2261
2278
  @validate_arguments
2262
- def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
2279
+ def get_instrument_property_time_series(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
2263
2280
  """GetInstrumentPropertyTimeSeries: Get instrument property time series # noqa: E501
2264
2281
 
2265
2282
  Retrieve the complete time series (history) for a particular property of an instrument. # noqa: E501
@@ -2306,7 +2323,7 @@ class InstrumentsApi:
2306
2323
  return self.get_instrument_property_time_series_with_http_info(identifier_type, identifier, property_key, identifier_effective_at, as_at, filter, page, limit, scope, **kwargs) # noqa: E501
2307
2324
 
2308
2325
  @validate_arguments
2309
- def get_instrument_property_time_series_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2326
+ def get_instrument_property_time_series_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], property_key : Annotated[StrictStr, Field(..., description="The property key of a property from the 'Instrument' domain whose history to retrieve. This must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")], identifier_effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime used to resolve the instrument from the identifier. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument's property history. Defaults to returning the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2310
2327
  """GetInstrumentPropertyTimeSeries: Get instrument property time series # noqa: E501
2311
2328
 
2312
2329
  Retrieve the complete time series (history) for a particular property of an instrument. # noqa: E501
@@ -2468,16 +2485,17 @@ class InstrumentsApi:
2468
2485
  collection_formats=_collection_formats,
2469
2486
  _request_auth=_params.get('_request_auth'))
2470
2487
 
2488
+
2471
2489
  @overload
2472
- async def get_instrument_relationships(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
2490
+ async def get_instrument_relationships(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
2473
2491
  ...
2474
2492
 
2475
2493
  @overload
2476
- def get_instrument_relationships(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
2494
+ def get_instrument_relationships(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
2477
2495
  ...
2478
2496
 
2479
2497
  @validate_arguments
2480
- def get_instrument_relationships(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
2498
+ def get_instrument_relationships(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
2481
2499
  """[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2482
2500
 
2483
2501
  Get relationships for a particular Instrument. # noqa: E501
@@ -2520,7 +2538,7 @@ class InstrumentsApi:
2520
2538
  return self.get_instrument_relationships_with_http_info(identifier_type, identifier, effective_at, as_at, filter, identifier_types, scope, **kwargs) # noqa: E501
2521
2539
 
2522
2540
  @validate_arguments
2523
- def get_instrument_relationships_with_http_info(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The identifier value.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2541
+ def get_instrument_relationships_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2524
2542
  """[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2525
2543
 
2526
2544
  Get relationships for a particular Instrument. # noqa: E501
@@ -2671,16 +2689,17 @@ class InstrumentsApi:
2671
2689
  collection_formats=_collection_formats,
2672
2690
  _request_auth=_params.get('_request_auth'))
2673
2691
 
2692
+
2674
2693
  @overload
2675
- async def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> GetInstrumentsResponse: # noqa: E501
2694
+ async def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> GetInstrumentsResponse: # noqa: E501
2676
2695
  ...
2677
2696
 
2678
2697
  @overload
2679
- def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetInstrumentsResponse: # noqa: E501
2698
+ def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetInstrumentsResponse: # noqa: E501
2680
2699
  ...
2681
2700
 
2682
2701
  @validate_arguments
2683
- def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetInstrumentsResponse, Awaitable[GetInstrumentsResponse]]: # noqa: E501
2702
+ def get_instruments(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetInstrumentsResponse, Awaitable[GetInstrumentsResponse]]: # noqa: E501
2684
2703
  """GetInstruments: Get instruments # noqa: E501
2685
2704
 
2686
2705
  Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. # noqa: E501
@@ -2723,7 +2742,7 @@ class InstrumentsApi:
2723
2742
  return self.get_instruments_with_http_info(identifier_type, request_body, effective_at, as_at, property_keys, scope, relationship_definition_ids, **kwargs) # noqa: E501
2724
2743
 
2725
2744
  @validate_arguments
2726
- def get_instruments_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2745
+ def get_instruments_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to use, for example 'Figi'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of one or more <i>identifierType</i> values to use to identify instruments.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definitions. Defaults to returning the latest version of each instrument definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto each instrument, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2727
2746
  """GetInstruments: Get instruments # noqa: E501
2728
2747
 
2729
2748
  Retrieve the definition of one or more instruments, as identified by a collection of unique identifiers. Note that to retrieve all the instruments in the instrument master, use the List instruments endpoint instead. # noqa: E501
@@ -2882,16 +2901,17 @@ class InstrumentsApi:
2882
2901
  collection_formats=_collection_formats,
2883
2902
  _request_auth=_params.get('_request_auth'))
2884
2903
 
2904
+
2885
2905
  @overload
2886
- async def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfProperty: # noqa: E501
2906
+ async def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ResourceListOfProperty: # noqa: E501
2887
2907
  ...
2888
2908
 
2889
2909
  @overload
2890
- def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfProperty: # noqa: E501
2910
+ def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfProperty: # noqa: E501
2891
2911
  ...
2892
2912
 
2893
2913
  @validate_arguments
2894
- def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProperty, Awaitable[ResourceListOfProperty]]: # noqa: E501
2914
+ def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProperty, Awaitable[ResourceListOfProperty]]: # noqa: E501
2895
2915
  """[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2896
2916
 
2897
2917
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -2934,7 +2954,7 @@ class InstrumentsApi:
2934
2954
  return self.list_instrument_properties_with_http_info(identifier_type, identifier, effective_at, as_at, page, limit, scope, **kwargs) # noqa: E501
2935
2955
 
2936
2956
  @validate_arguments
2937
- def list_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[constr(strict=True, max_length=256, min_length=0)], Field(description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2957
+ def list_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2938
2958
  """[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2939
2959
 
2940
2960
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
@@ -3084,16 +3104,17 @@ class InstrumentsApi:
3084
3104
  collection_formats=_collection_formats,
3085
3105
  _request_auth=_params.get('_request_auth'))
3086
3106
 
3107
+
3087
3108
  @overload
3088
- async def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use.")] = None, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3109
+ async def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. 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 instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use.")] = None, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3089
3110
  ...
3090
3111
 
3091
3112
  @overload
3092
- def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3113
+ def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. 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 instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfInstrument: # noqa: E501
3093
3114
  ...
3094
3115
 
3095
3116
  @validate_arguments
3096
- def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfInstrument, Awaitable[PagedResourceListOfInstrument]]: # noqa: E501
3117
+ def list_instruments(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. 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 instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfInstrument, Awaitable[PagedResourceListOfInstrument]]: # noqa: E501
3097
3118
  """ListInstruments: List instruments # noqa: E501
3098
3119
 
3099
3120
  List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. # noqa: E501
@@ -3144,7 +3165,7 @@ class InstrumentsApi:
3144
3165
  return self.list_instruments_with_http_info(as_at, effective_at, page, sort_by, limit, filter, instrument_property_keys, scope, relationship_definition_ids, data_model_scope, data_model_code, **kwargs) # noqa: E501
3145
3166
 
3146
3167
  @validate_arguments
3147
- def list_instruments_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list instruments. Defaults to the current LUSID system datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3168
+ def list_instruments_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list instruments. Defaults to returning the latest version of each instrument if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list instruments. 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 instruments; this value is returned from the previous call. If a pagination token is provided, the <i>sortBy</i>, <i>filter</i>, <i>effectiveAt</i> and <i>asAt</i> fields must not have changed since the original request. For more information, see https://support.lusid.com/knowledgebase/article/KA-01915.")] = 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, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Defaults to filtering out inactive instruments (that is, those that have been deleted). For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, instrument_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument' domain to decorate onto instruments, or from any domain that supports relationships to decorate onto related entities. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name'.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto each instrument in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use.")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3148
3169
  """ListInstruments: List instruments # noqa: E501
3149
3170
 
3150
3171
  List all the instruments in the instrument master. To retrieve a particular set of instruments instead, use the Get instruments endpoint. The maximum number of instruments that this method can list per request is 2,000. # noqa: E501
@@ -3321,16 +3342,17 @@ class InstrumentsApi:
3321
3342
  collection_formats=_collection_formats,
3322
3343
  _request_auth=_params.get('_request_auth'))
3323
3344
 
3345
+
3324
3346
  @overload
3325
- async def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, **kwargs) -> InstrumentCapabilities: # noqa: E501
3347
+ async def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, **kwargs) -> InstrumentCapabilities: # noqa: E501
3326
3348
  ...
3327
3349
 
3328
3350
  @overload
3329
- def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentCapabilities: # noqa: E501
3351
+ def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> InstrumentCapabilities: # noqa: E501
3330
3352
  ...
3331
3353
 
3332
3354
  @validate_arguments
3333
- def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
3355
+ def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
3334
3356
  """[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3335
3357
 
3336
3358
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
@@ -3363,7 +3385,7 @@ class InstrumentsApi:
3363
3385
  return self.query_instrument_capabilities_with_http_info(lusid_instrument, model, **kwargs) # noqa: E501
3364
3386
 
3365
3387
  @validate_arguments
3366
- def query_instrument_capabilities_with_http_info(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[constr(strict=True, max_length=256, min_length=1)], Field(description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3388
+ def query_instrument_capabilities_with_http_info(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3367
3389
  """[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3368
3390
 
3369
3391
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
@@ -3487,16 +3509,17 @@ class InstrumentsApi:
3487
3509
  collection_formats=_collection_formats,
3488
3510
  _request_auth=_params.get('_request_auth'))
3489
3511
 
3512
+
3490
3513
  @overload
3491
- async def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> Instrument: # noqa: E501
3514
+ async def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> Instrument: # noqa: E501
3492
3515
  ...
3493
3516
 
3494
3517
  @overload
3495
- def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> Instrument: # noqa: E501
3518
+ def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> Instrument: # noqa: E501
3496
3519
  ...
3497
3520
 
3498
3521
  @validate_arguments
3499
- def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Instrument, Awaitable[Instrument]]: # noqa: E501
3522
+ def update_instrument_identifier(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Instrument, Awaitable[Instrument]]: # noqa: E501
3500
3523
  """UpdateInstrumentIdentifier: Update instrument identifier # noqa: E501
3501
3524
 
3502
3525
  Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. # noqa: E501
@@ -3533,7 +3556,7 @@ class InstrumentsApi:
3533
3556
  return self.update_instrument_identifier_with_http_info(identifier_type, identifier, update_instrument_identifier_request, scope, **kwargs) # noqa: E501
3534
3557
 
3535
3558
  @validate_arguments
3536
- def update_instrument_identifier_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3559
+ def update_instrument_identifier_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], update_instrument_identifier_request : Annotated[UpdateInstrumentIdentifierRequest, Field(..., description="The identifier to update or delete. This need not be the same value as the 'identifier' parameter used to retrieve the instrument.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3537
3560
  """UpdateInstrumentIdentifier: Update instrument identifier # noqa: E501
3538
3561
 
3539
3562
  Create, update or delete a particular instrument identifier for an instrument. To delete the identifier, leave the value unspecified in the request. If not being deleted, the identifier is updated if it exists and created if it does not. # noqa: E501
@@ -3669,16 +3692,17 @@ class InstrumentsApi:
3669
3692
  collection_formats=_collection_formats,
3670
3693
  _request_auth=_params.get('_request_auth'))
3671
3694
 
3695
+
3672
3696
  @overload
3673
- async def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use")] = None, **kwargs) -> UpsertInstrumentsResponse: # noqa: E501
3697
+ async def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, **kwargs) -> UpsertInstrumentsResponse: # noqa: E501
3674
3698
  ...
3675
3699
 
3676
3700
  @overload
3677
- def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertInstrumentsResponse: # noqa: E501
3701
+ def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertInstrumentsResponse: # noqa: E501
3678
3702
  ...
3679
3703
 
3680
3704
  @validate_arguments
3681
- def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertInstrumentsResponse, Awaitable[UpsertInstrumentsResponse]]: # noqa: E501
3705
+ def upsert_instruments(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertInstrumentsResponse, Awaitable[UpsertInstrumentsResponse]]: # noqa: E501
3682
3706
  """UpsertInstruments: Upsert instruments # noqa: E501
3683
3707
 
3684
3708
  Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. # noqa: E501
@@ -3715,7 +3739,7 @@ class InstrumentsApi:
3715
3739
  return self.upsert_instruments_with_http_info(request_body, scope, data_model_scope, data_model_code, **kwargs) # noqa: E501
3716
3740
 
3717
3741
  @validate_arguments
3718
- def upsert_instruments_with_http_info(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The optional code of a Hierarchical Data Model to use")] = None, **kwargs) -> ApiResponse: # noqa: E501
3742
+ def upsert_instruments_with_http_info(self, request_body : Annotated[Dict[str, InstrumentDefinition], Field(..., description="The definitions of the instruments to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, **kwargs) -> ApiResponse: # noqa: E501
3719
3743
  """UpsertInstruments: Upsert instruments # noqa: E501
3720
3744
 
3721
3745
  Create or update one or more instruments in the instrument master. An instrument is updated if it already exists and created if it does not. In the request, each instrument definition should be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each instrument in the response. Note that an instrument must have at least one unique identifier, which is a combination of a type (such as 'Figi') and a value (such as 'BBG000BS1N49'). In addition, a random value is automatically generated for a LUSID Instrument ID (LUID) unique type by the system. For more information, see https://support.lusid.com/knowledgebase/article/KA-01862. The response returns both the collection of successfully created or updated instruments, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for unsuccessful results. The maximum number of instruments that this method can upsert per request is 2,000. # noqa: E501
@@ -3851,16 +3875,17 @@ class InstrumentsApi:
3851
3875
  collection_formats=_collection_formats,
3852
3876
  _request_auth=_params.get('_request_auth'))
3853
3877
 
3878
+
3854
3879
  @overload
3855
- async def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> UpsertInstrumentPropertiesResponse: # noqa: E501
3880
+ async def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> UpsertInstrumentPropertiesResponse: # noqa: E501
3856
3881
  ...
3857
3882
 
3858
3883
  @overload
3859
- def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertInstrumentPropertiesResponse: # noqa: E501
3884
+ def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=True, **kwargs) -> UpsertInstrumentPropertiesResponse: # noqa: E501
3860
3885
  ...
3861
3886
 
3862
3887
  @validate_arguments
3863
- def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertInstrumentPropertiesResponse, Awaitable[UpsertInstrumentPropertiesResponse]]: # noqa: E501
3888
+ def upsert_instruments_properties(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[UpsertInstrumentPropertiesResponse, Awaitable[UpsertInstrumentPropertiesResponse]]: # noqa: E501
3864
3889
  """UpsertInstrumentsProperties: Upsert instruments properties # noqa: E501
3865
3890
 
3866
3891
  Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501
@@ -3893,7 +3918,7 @@ class InstrumentsApi:
3893
3918
  return self.upsert_instruments_properties_with_http_info(upsert_instrument_property_request, scope, **kwargs) # noqa: E501
3894
3919
 
3895
3920
  @validate_arguments
3896
- def upsert_instruments_properties_with_http_info(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3921
+ def upsert_instruments_properties_with_http_info(self, upsert_instrument_property_request : Annotated[conlist(UpsertInstrumentPropertyRequest), Field(..., description="A list of instruments and associated instrument properties to create or update.")], scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3897
3922
  """UpsertInstrumentsProperties: Upsert instruments properties # noqa: E501
3898
3923
 
3899
3924
  Create or update one or more properties for particular instruments. Each instrument property is updated if it exists and created if it does not. For any failures, a reason is provided. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501