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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. lusid/api/abor_api.py +66 -66
  2. lusid/api/abor_configuration_api.py +32 -32
  3. lusid/api/address_key_definition_api.py +10 -10
  4. lusid/api/aggregated_returns_api.py +12 -12
  5. lusid/api/aggregation_api.py +10 -10
  6. lusid/api/allocations_api.py +24 -24
  7. lusid/api/amortisation_rule_sets_api.py +24 -24
  8. lusid/api/application_metadata_api.py +6 -6
  9. lusid/api/blocks_api.py +18 -18
  10. lusid/api/calendars_api.py +34 -34
  11. lusid/api/chart_of_accounts_api.py +122 -122
  12. lusid/api/check_definitions_api.py +38 -38
  13. lusid/api/complex_market_data_api.py +36 -36
  14. lusid/api/compliance_api.py +34 -34
  15. lusid/api/configuration_recipe_api.py +20 -20
  16. lusid/api/conventions_api.py +18 -18
  17. lusid/api/corporate_action_sources_api.py +32 -32
  18. lusid/api/counterparties_api.py +12 -12
  19. lusid/api/custom_data_models_api.py +16 -16
  20. lusid/api/custom_entities_api.py +40 -40
  21. lusid/api/custom_entity_definitions_api.py +10 -10
  22. lusid/api/custom_entity_types_api.py +10 -10
  23. lusid/api/cut_label_definitions_api.py +8 -8
  24. lusid/api/data_types_api.py +34 -34
  25. lusid/api/derived_transaction_portfolios_api.py +6 -6
  26. lusid/api/entities_api.py +20 -20
  27. lusid/api/executions_api.py +18 -18
  28. lusid/api/fee_types_api.py +8 -8
  29. lusid/api/fund_configuration_api.py +38 -38
  30. lusid/api/funds_api.py +126 -126
  31. lusid/api/group_reconciliations_api.py +84 -84
  32. lusid/api/identifier_definitions_api.py +30 -30
  33. lusid/api/instrument_event_types_api.py +40 -40
  34. lusid/api/instrument_events_api.py +34 -34
  35. lusid/api/instruments_api.py +138 -138
  36. lusid/api/investment_accounts_api.py +24 -24
  37. lusid/api/investor_records_api.py +26 -26
  38. lusid/api/legacy_compliance_api.py +46 -46
  39. lusid/api/legal_entities_api.py +114 -114
  40. lusid/api/order_graph_api.py +6 -6
  41. lusid/api/order_instructions_api.py +18 -18
  42. lusid/api/order_management_api.py +28 -28
  43. lusid/api/orders_api.py +18 -18
  44. lusid/api/packages_api.py +18 -18
  45. lusid/api/participations_api.py +18 -18
  46. lusid/api/persons_api.py +114 -114
  47. lusid/api/placements_api.py +18 -18
  48. lusid/api/portfolio_groups_api.py +156 -156
  49. lusid/api/portfolios_api.py +128 -128
  50. lusid/api/property_definitions_api.py +74 -74
  51. lusid/api/queryable_keys_api.py +6 -6
  52. lusid/api/quotes_api.py +36 -36
  53. lusid/api/reconciliations_api.py +42 -42
  54. lusid/api/reference_lists_api.py +8 -8
  55. lusid/api/reference_portfolio_api.py +30 -30
  56. lusid/api/relation_definitions_api.py +14 -14
  57. lusid/api/relationship_definitions_api.py +32 -32
  58. lusid/api/scopes_api.py +12 -12
  59. lusid/api/scripted_translation_api.py +22 -22
  60. lusid/api/search_api.py +28 -28
  61. lusid/api/sequences_api.py +20 -20
  62. lusid/api/staged_modifications_api.py +20 -20
  63. lusid/api/staging_rule_set_api.py +18 -18
  64. lusid/api/structured_result_data_api.py +38 -38
  65. lusid/api/system_configuration_api.py +20 -20
  66. lusid/api/tax_rule_sets_api.py +34 -34
  67. lusid/api/timelines_api.py +68 -68
  68. lusid/api/transaction_configuration_api.py +18 -18
  69. lusid/api/transaction_fees_api.py +42 -42
  70. lusid/api/transaction_portfolios_api.py +450 -450
  71. lusid/api/transfer_agency_api.py +2 -2
  72. lusid/api/translation_api.py +4 -4
  73. lusid/api/workspace_api.py +24 -24
  74. lusid/configuration.py +1 -1
  75. lusid/models/access_metadata_value.py +1 -1
  76. lusid/models/accumulation_event.py +1 -1
  77. lusid/models/additional_payment.py +1 -1
  78. lusid/models/address_definition.py +2 -2
  79. lusid/models/adjust_global_commitment_event.py +2 -2
  80. lusid/models/adjust_holding_for_date_request.py +1 -1
  81. lusid/models/adjust_holding_request.py +1 -1
  82. lusid/models/aggregate_spec.py +1 -1
  83. lusid/models/aggregation_context.py +1 -1
  84. lusid/models/aggregation_options.py +3 -3
  85. lusid/models/allocation.py +1 -1
  86. lusid/models/amortisation_event.py +2 -2
  87. lusid/models/append_fx_forward_curve_by_quote_reference.py +1 -1
  88. lusid/models/asset_leg.py +2 -2
  89. lusid/models/basket.py +1 -1
  90. lusid/models/block.py +1 -1
  91. lusid/models/bond.py +5 -5
  92. lusid/models/bond_conversion_entry.py +3 -3
  93. lusid/models/bond_conversion_schedule.py +5 -5
  94. lusid/models/bond_coupon_event.py +1 -1
  95. lusid/models/bond_principal_event.py +1 -1
  96. lusid/models/bucketed_cash_flow_response.py +3 -3
  97. lusid/models/cancel_single_holding_adjustment_request.py +1 -1
  98. lusid/models/cap_floor.py +2 -2
  99. lusid/models/cash_and_security_offer_election.py +1 -1
  100. lusid/models/cash_dependency.py +2 -2
  101. lusid/models/cash_flow_event.py +1 -1
  102. lusid/models/cash_flow_lineage.py +2 -2
  103. lusid/models/cash_offer_election.py +1 -1
  104. lusid/models/cds_flow_conventions.py +5 -5
  105. lusid/models/cds_index.py +4 -4
  106. lusid/models/cds_protection_detail_specification.py +3 -3
  107. lusid/models/change_item.py +1 -1
  108. lusid/models/close_event.py +1 -1
  109. lusid/models/collateral.py +2 -2
  110. lusid/models/complex_bond.py +4 -4
  111. lusid/models/complex_market_data.py +1 -1
  112. lusid/models/complex_market_data_id.py +1 -1
  113. lusid/models/compounding.py +6 -6
  114. lusid/models/configuration_recipe.py +1 -1
  115. lusid/models/constant_volatility_surface.py +2 -2
  116. lusid/models/constituents_adjustment_header.py +1 -1
  117. lusid/models/contract_for_difference.py +6 -6
  118. lusid/models/conversion_event.py +9 -9
  119. lusid/models/corporate_action_transition_component_request.py +1 -1
  120. lusid/models/counterparty_agreement.py +1 -1
  121. lusid/models/counterparty_risk_information.py +1 -1
  122. lusid/models/counterparty_signatory.py +1 -1
  123. lusid/models/credit_default_swap.py +4 -4
  124. lusid/models/credit_premium_cash_flow_event.py +1 -1
  125. lusid/models/credit_rating.py +1 -1
  126. lusid/models/credit_spread_curve_data.py +3 -3
  127. lusid/models/credit_support_annex.py +6 -6
  128. lusid/models/curve_options.py +2 -2
  129. lusid/models/data_definition.py +3 -3
  130. lusid/models/data_map_key.py +1 -1
  131. lusid/models/data_mapping.py +1 -1
  132. lusid/models/dependency_source_filter.py +6 -6
  133. lusid/models/dialect.py +1 -1
  134. lusid/models/dialect_schema.py +1 -1
  135. lusid/models/discounting_dependency.py +2 -2
  136. lusid/models/dividend_option_event.py +1 -1
  137. lusid/models/dividend_reinvestment_event.py +1 -1
  138. lusid/models/early_redemption_election.py +1 -1
  139. lusid/models/early_redemption_event.py +2 -2
  140. lusid/models/economic_dependency.py +1 -1
  141. lusid/models/equity.py +1 -1
  142. lusid/models/equity_curve_by_prices_data.py +1 -1
  143. lusid/models/equity_curve_dependency.py +2 -2
  144. lusid/models/equity_model_options.py +1 -1
  145. lusid/models/equity_option.py +7 -7
  146. lusid/models/equity_swap.py +6 -6
  147. lusid/models/equity_vol_dependency.py +2 -2
  148. lusid/models/event_date_range.py +1 -1
  149. lusid/models/ex_dividend_configuration.py +3 -3
  150. lusid/models/exchange_traded_option.py +1 -1
  151. lusid/models/exchange_traded_option_contract_details.py +5 -5
  152. lusid/models/execution.py +1 -1
  153. lusid/models/exercise_event.py +1 -1
  154. lusid/models/exotic_instrument.py +1 -1
  155. lusid/models/expiry_event.py +1 -1
  156. lusid/models/fixed_leg.py +1 -1
  157. lusid/models/fixed_leg_all_of_overrides.py +1 -1
  158. lusid/models/fixed_schedule.py +3 -3
  159. lusid/models/flexible_deposit.py +2 -2
  160. lusid/models/flexible_loan.py +2 -2
  161. lusid/models/flexible_repo.py +10 -10
  162. lusid/models/flexible_repo_cash_flow_event.py +2 -2
  163. lusid/models/flexible_repo_collateral_event.py +2 -2
  164. lusid/models/flexible_repo_interest_payment_event.py +2 -2
  165. lusid/models/flexible_repo_partial_closure_event.py +5 -5
  166. lusid/models/float_schedule.py +5 -5
  167. lusid/models/floating_leg.py +1 -1
  168. lusid/models/flow_convention_name.py +1 -1
  169. lusid/models/flow_conventions.py +9 -9
  170. lusid/models/forward_rate_agreement.py +1 -1
  171. lusid/models/fund_share_class.py +4 -4
  172. lusid/models/fund_valuation_request.py +4 -4
  173. lusid/models/fund_valuation_schedule.py +4 -4
  174. lusid/models/funding_leg.py +3 -3
  175. lusid/models/future.py +4 -4
  176. lusid/models/future_expiry_event.py +1 -1
  177. lusid/models/future_mark_to_market_event.py +1 -1
  178. lusid/models/futures_contract_details.py +5 -5
  179. lusid/models/fx_conventions.py +1 -1
  180. lusid/models/fx_dependency.py +1 -1
  181. lusid/models/fx_forward.py +6 -6
  182. lusid/models/fx_forward_curve_by_quote_reference.py +3 -3
  183. lusid/models/fx_forward_model_options.py +1 -1
  184. lusid/models/fx_forward_settlement_event.py +6 -6
  185. lusid/models/fx_forward_tenor_curve_data.py +2 -2
  186. lusid/models/fx_forward_tenor_pips_curve_data.py +2 -2
  187. lusid/models/fx_forwards_dependency.py +3 -3
  188. lusid/models/fx_linked_notional_schedule.py +1 -1
  189. lusid/models/fx_option.py +8 -8
  190. lusid/models/fx_rate_schedule.py +1 -1
  191. lusid/models/fx_swap.py +2 -2
  192. lusid/models/fx_tenor_convention.py +1 -1
  193. lusid/models/fx_vol_dependency.py +2 -2
  194. lusid/models/get_reference_portfolio_constituents_response.py +1 -1
  195. lusid/models/group_of_market_data_key_rules.py +2 -2
  196. lusid/models/holding_context.py +1 -1
  197. lusid/models/holding_pricing_info.py +2 -2
  198. lusid/models/index_convention.py +4 -4
  199. lusid/models/index_projection_dependency.py +2 -2
  200. lusid/models/industry_classifier.py +1 -1
  201. lusid/models/inflation_index_conventions.py +4 -4
  202. lusid/models/inflation_leg.py +5 -5
  203. lusid/models/inflation_linked_bond.py +6 -6
  204. lusid/models/inflation_swap.py +3 -3
  205. lusid/models/informational_event.py +3 -3
  206. lusid/models/inline_valuation_request.py +6 -6
  207. lusid/models/inline_valuations_reconciliation_request.py +1 -1
  208. lusid/models/instrument_capabilities.py +1 -1
  209. lusid/models/instrument_definition_format.py +2 -2
  210. lusid/models/instrument_event.py +1 -1
  211. lusid/models/instrument_leg.py +1 -1
  212. lusid/models/interest_rate_swap.py +4 -4
  213. lusid/models/interest_rate_swaption.py +2 -2
  214. lusid/models/ir_vol_dependency.py +2 -2
  215. lusid/models/lapse_election.py +1 -1
  216. lusid/models/leg_definition.py +8 -8
  217. lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
  218. lusid/models/loan_facility.py +3 -3
  219. lusid/models/loan_facility_contract_rollover_event.py +2 -2
  220. lusid/models/loan_interest_repayment_event.py +2 -2
  221. lusid/models/loan_principal_repayment_event.py +3 -3
  222. lusid/models/lusid_instrument.py +1 -1
  223. lusid/models/lusid_trade_ticket.py +1 -1
  224. lusid/models/mark_to_market_conventions.py +1 -1
  225. lusid/models/market_context.py +4 -4
  226. lusid/models/market_context_suppliers.py +1 -1
  227. lusid/models/market_data_key_rule.py +7 -7
  228. lusid/models/market_data_options.py +1 -1
  229. lusid/models/market_data_specific_rule.py +6 -6
  230. lusid/models/market_data_type.py +1 -1
  231. lusid/models/market_options.py +1 -1
  232. lusid/models/market_quote.py +1 -1
  233. lusid/models/mastered_instrument.py +1 -1
  234. lusid/models/match_criterion.py +1 -1
  235. lusid/models/maturity_event.py +1 -1
  236. lusid/models/mbs_coupon_event.py +1 -1
  237. lusid/models/mbs_interest_deferral_event.py +1 -1
  238. lusid/models/mbs_interest_shortfall_event.py +1 -1
  239. lusid/models/mbs_principal_event.py +1 -1
  240. lusid/models/mbs_principal_write_off_event.py +1 -1
  241. lusid/models/model_options.py +1 -1
  242. lusid/models/model_selection.py +1 -1
  243. lusid/models/opaque_dependency.py +1 -1
  244. lusid/models/opaque_market_data.py +3 -3
  245. lusid/models/option_entry.py +1 -1
  246. lusid/models/option_exercise_cash_event.py +3 -3
  247. lusid/models/option_exercise_election.py +1 -1
  248. lusid/models/option_exercise_physical_event.py +3 -3
  249. lusid/models/optionality_schedule.py +2 -2
  250. lusid/models/order_flow_configuration.py +1 -1
  251. lusid/models/partial_closure_constituent.py +3 -3
  252. lusid/models/portfolio_holding.py +6 -2
  253. lusid/models/portfolio_result_data_key_rule.py +1 -1
  254. lusid/models/pre_trade_configuration.py +1 -1
  255. lusid/models/pricing_context.py +3 -3
  256. lusid/models/pricing_options.py +9 -9
  257. lusid/models/property_domain.py +1 -1
  258. lusid/models/property_reference_data_value.py +1 -1
  259. lusid/models/quote_dependency.py +1 -1
  260. lusid/models/quote_series_id.py +1 -1
  261. lusid/models/raw_vendor_event.py +1 -1
  262. lusid/models/recipe_value.py +1 -1
  263. lusid/models/reconcile_date_time_rule.py +1 -1
  264. lusid/models/reconcile_numeric_rule.py +1 -1
  265. lusid/models/reconcile_string_rule.py +1 -1
  266. lusid/models/reconciled_transaction.py +2 -2
  267. lusid/models/reconciliation_line.py +1 -1
  268. lusid/models/reconciliation_request.py +3 -3
  269. lusid/models/reconciliation_rule.py +1 -1
  270. lusid/models/relative_date_offset.py +2 -2
  271. lusid/models/repo.py +8 -8
  272. lusid/models/repo_cash_flow_event.py +4 -4
  273. lusid/models/repo_partial_closure_event.py +5 -5
  274. lusid/models/repurchase_offer_event.py +4 -4
  275. lusid/models/reset_event.py +1 -1
  276. lusid/models/result_data_key_rule.py +6 -4
  277. lusid/models/result_data_schema.py +1 -1
  278. lusid/models/result_key_rule.py +1 -1
  279. lusid/models/result_value.py +1 -1
  280. lusid/models/result_value0_d.py +1 -1
  281. lusid/models/result_value_date_time_offset.py +1 -1
  282. lusid/models/result_value_decimal.py +1 -1
  283. lusid/models/result_value_int.py +1 -1
  284. lusid/models/return_zero_pv_options.py +1 -1
  285. lusid/models/rounding_convention.py +4 -4
  286. lusid/models/schedule.py +1 -1
  287. lusid/models/scrip_dividend_event.py +1 -1
  288. lusid/models/security_election.py +2 -2
  289. lusid/models/security_offer_election.py +1 -1
  290. lusid/models/settlement_schedule.py +20 -2
  291. lusid/models/side_configuration_data.py +1 -1
  292. lusid/models/side_configuration_data_request.py +1 -1
  293. lusid/models/simple_cash_flow_loan.py +2 -2
  294. lusid/models/simple_instrument.py +2 -2
  295. lusid/models/simple_rounding_convention.py +2 -2
  296. lusid/models/step_schedule.py +3 -3
  297. lusid/models/stock_dividend_event.py +1 -1
  298. lusid/models/structured_result_data.py +1 -1
  299. lusid/models/swap_cash_flow_event.py +1 -1
  300. lusid/models/swap_principal_event.py +1 -1
  301. lusid/models/tender_offer_election.py +1 -1
  302. lusid/models/term_deposit.py +1 -1
  303. lusid/models/term_deposit_interest_event.py +1 -1
  304. lusid/models/term_deposit_principal_event.py +1 -1
  305. lusid/models/time_zone_conventions.py +1 -1
  306. lusid/models/total_return_swap.py +3 -3
  307. lusid/models/trading_conventions.py +3 -3
  308. lusid/models/transaction_reconciliation_request_v2.py +3 -3
  309. lusid/models/translate_entities_inlined_request.py +1 -1
  310. lusid/models/translate_entities_request.py +1 -1
  311. lusid/models/translate_instrument_definitions_request.py +1 -1
  312. lusid/models/translate_trade_ticket_request.py +1 -1
  313. lusid/models/translation_input.py +1 -1
  314. lusid/models/trigger_event.py +1 -1
  315. lusid/models/typed_resource_id.py +2 -2
  316. lusid/models/unmatched_holding_method.py +1 -1
  317. lusid/models/upsert_cds_flow_conventions_request.py +1 -1
  318. lusid/models/upsert_counterparty_agreement_request.py +1 -1
  319. lusid/models/upsert_flow_conventions_request.py +1 -1
  320. lusid/models/upsert_index_convention_request.py +1 -1
  321. lusid/models/upsert_quote_request.py +1 -1
  322. lusid/models/upsert_recipe_request.py +1 -1
  323. lusid/models/valuation_request.py +5 -5
  324. lusid/models/valuation_schedule.py +5 -5
  325. lusid/models/valuations_reconciliation_request.py +2 -2
  326. lusid/models/vendor_model_rule.py +3 -3
  327. lusid/models/virtual_document.py +1 -1
  328. lusid/models/weighted_instrument.py +2 -2
  329. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
  330. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/METADATA +3 -3
  331. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/RECORD +332 -332
  332. {lusid_sdk-2.1.910.dist-info → lusid_sdk-2.1.912.dist-info}/WHEEL +0 -0
@@ -73,7 +73,7 @@ class CustomDataModelsApi:
73
73
  def batch_amend(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], async_req: Optional[bool]=None, **kwargs) -> Union[BatchAmendCustomDataModelMembershipResponse, Awaitable[BatchAmendCustomDataModelMembershipResponse]]: # noqa: E501
74
74
  """[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. # noqa: E501
75
75
 
76
- Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. # noqa: E501
76
+ Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. # noqa: E501
77
77
  This method makes a synchronous HTTP request by default. To make an
78
78
  asynchronous HTTP request, please pass async_req=True
79
79
 
@@ -106,7 +106,7 @@ class CustomDataModelsApi:
106
106
  def batch_amend_with_http_info(self, success_mode : Annotated[StrictStr, Field(..., description="Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.")], request_body : Annotated[Dict[str, MembershipAmendmentRequest], Field(..., description="The payload describing the amendments to make for the given Custom Data Model.")], **kwargs) -> ApiResponse: # noqa: E501
107
107
  """[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. # noqa: E501
108
108
 
109
- Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. # noqa: E501
109
+ Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. # noqa: E501
110
110
  This method makes a synchronous HTTP request by default. To make an
111
111
  asynchronous HTTP request, please pass async_req=True
112
112
 
@@ -407,7 +407,7 @@ class CustomDataModelsApi:
407
407
  def delete_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
408
408
  """[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
409
409
 
410
- Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # noqa: E501
410
+ Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # noqa: E501
411
411
  This method makes a synchronous HTTP request by default. To make an
412
412
  asynchronous HTTP request, please pass async_req=True
413
413
 
@@ -442,7 +442,7 @@ class CustomDataModelsApi:
442
442
  def delete_custom_data_model_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], **kwargs) -> ApiResponse: # noqa: E501
443
443
  """[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
444
444
 
445
- Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # noqa: E501
445
+ Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # noqa: E501
446
446
  This method makes a synchronous HTTP request by default. To make an
447
447
  asynchronous HTTP request, please pass async_req=True
448
448
 
@@ -564,15 +564,15 @@ class CustomDataModelsApi:
564
564
 
565
565
 
566
566
  @overload
567
- async def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, **kwargs) -> CustomDataModel: # noqa: E501
567
+ async def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, **kwargs) -> CustomDataModel: # noqa: E501
568
568
  ...
569
569
 
570
570
  @overload
571
- def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomDataModel: # noqa: E501
571
+ def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomDataModel: # noqa: E501
572
572
  ...
573
573
 
574
574
  @validate_arguments
575
- def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomDataModel, Awaitable[CustomDataModel]]: # noqa: E501
575
+ def get_custom_data_model(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomDataModel, Awaitable[CustomDataModel]]: # noqa: E501
576
576
  """[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
577
577
 
578
578
  Retrieves a Custom Data Model at a given as at time. # noqa: E501
@@ -588,7 +588,7 @@ class CustomDataModelsApi:
588
588
  :type scope: str
589
589
  :param code: The code of the specified Data Model. (required)
590
590
  :type code: str
591
- :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
591
+ :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
592
592
  :type as_at: datetime
593
593
  :param async_req: Whether to execute the request asynchronously.
594
594
  :type async_req: bool, optional
@@ -609,7 +609,7 @@ class CustomDataModelsApi:
609
609
  return self.get_custom_data_model_with_http_info(entity_type, scope, code, as_at, **kwargs) # noqa: E501
610
610
 
611
611
  @validate_arguments
612
- def get_custom_data_model_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
612
+ def get_custom_data_model_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type of the Data Model.")], scope : Annotated[StrictStr, Field(..., description="The scope of the specified Data Model.")], code : Annotated[StrictStr, Field(..., description="The code of the specified Data Model.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
613
613
  """[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
614
614
 
615
615
  Retrieves a Custom Data Model at a given as at time. # noqa: E501
@@ -625,7 +625,7 @@ class CustomDataModelsApi:
625
625
  :type scope: str
626
626
  :param code: The code of the specified Data Model. (required)
627
627
  :type code: str
628
- :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
628
+ :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
629
629
  :type as_at: datetime
630
630
  :param async_req: Whether to execute the request asynchronously.
631
631
  :type async_req: bool, optional
@@ -743,15 +743,15 @@ class CustomDataModelsApi:
743
743
 
744
744
 
745
745
  @overload
746
- async def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, **kwargs) -> ResourceListOfDataModelSummary: # noqa: E501
746
+ async def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, **kwargs) -> ResourceListOfDataModelSummary: # noqa: E501
747
747
  ...
748
748
 
749
749
  @overload
750
- def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfDataModelSummary: # noqa: E501
750
+ def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfDataModelSummary: # noqa: E501
751
751
  ...
752
752
 
753
753
  @validate_arguments
754
- def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfDataModelSummary, Awaitable[ResourceListOfDataModelSummary]]: # noqa: E501
754
+ def list_data_model_hierarchies(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfDataModelSummary, Awaitable[ResourceListOfDataModelSummary]]: # noqa: E501
755
755
  """[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. # noqa: E501
756
756
 
757
757
  Lists the data model summaries within their hierarchical structure. # noqa: E501
@@ -761,7 +761,7 @@ class CustomDataModelsApi:
761
761
  >>> thread = api.list_data_model_hierarchies(as_at, filter, async_req=True)
762
762
  >>> result = thread.get()
763
763
 
764
- :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
764
+ :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
765
765
  :type as_at: datetime
766
766
  :param filter: Expression to filter the results. Only EntityType is supported
767
767
  :type filter: str
@@ -784,7 +784,7 @@ class CustomDataModelsApi:
784
784
  return self.list_data_model_hierarchies_with_http_info(as_at, filter, **kwargs) # noqa: E501
785
785
 
786
786
  @validate_arguments
787
- def list_data_model_hierarchies_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, **kwargs) -> ApiResponse: # noqa: E501
787
+ def list_data_model_hierarchies_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. Only EntityType is supported")] = None, **kwargs) -> ApiResponse: # noqa: E501
788
788
  """[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. # noqa: E501
789
789
 
790
790
  Lists the data model summaries within their hierarchical structure. # noqa: E501
@@ -794,7 +794,7 @@ class CustomDataModelsApi:
794
794
  >>> thread = api.list_data_model_hierarchies_with_http_info(as_at, filter, async_req=True)
795
795
  >>> result = thread.get()
796
796
 
797
- :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
797
+ :param as_at: The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
798
798
  :type as_at: datetime
799
799
  :param filter: Expression to filter the results. Only EntityType is supported
800
800
  :type filter: str
@@ -250,7 +250,7 @@ class CustomEntitiesApi:
250
250
  def delete_custom_entity_access_metadata(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
251
251
  """[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
252
252
 
253
- Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
253
+ Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
254
254
  This method makes a synchronous HTTP request by default. To make an
255
255
  asynchronous HTTP request, please pass async_req=True
256
256
 
@@ -293,7 +293,7 @@ class CustomEntitiesApi:
293
293
  def delete_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to delete.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Access Metadata.")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata.")] = None, **kwargs) -> ApiResponse: # noqa: E501
294
294
  """[EARLY ACCESS] DeleteCustomEntityAccessMetadata: Delete a Custom Entity Access Metadata entry # noqa: E501
295
295
 
296
- Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
296
+ Deletes the Custom Entity Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
297
297
  This method makes a synchronous HTTP request by default. To make an
298
298
  asynchronous HTTP request, please pass async_req=True
299
299
 
@@ -637,15 +637,15 @@ class CustomEntitiesApi:
637
637
 
638
638
 
639
639
  @overload
640
- async def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> CustomEntityResponse: # noqa: E501
640
+ async def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> CustomEntityResponse: # noqa: E501
641
641
  ...
642
642
 
643
643
  @overload
644
- def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomEntityResponse: # noqa: E501
644
+ def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomEntityResponse: # noqa: E501
645
645
  ...
646
646
 
647
647
  @validate_arguments
648
- def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
648
+ def get_custom_entity(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityResponse, Awaitable[CustomEntityResponse]]: # noqa: E501
649
649
  """GetCustomEntity: Get a Custom Entity instance. # noqa: E501
650
650
 
651
651
  Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
@@ -667,11 +667,11 @@ class CustomEntitiesApi:
667
667
  :type as_at: datetime
668
668
  :param effective_at: The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
669
669
  :type effective_at: str
670
- :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
670
+ :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
671
671
  :type related_entity_property_keys: List[str]
672
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
672
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
673
673
  :type relationship_definition_ids: List[str]
674
- :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
674
+ :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
675
675
  :type property_keys: List[str]
676
676
  :param async_req: Whether to execute the request asynchronously.
677
677
  :type async_req: bool, optional
@@ -692,7 +692,7 @@ class CustomEntitiesApi:
692
692
  return self.get_custom_entity_with_http_info(entity_type, identifier_type, identifier_value, identifier_scope, as_at, effective_at, related_entity_property_keys, relationship_definition_ids, property_keys, **kwargs) # noqa: E501
693
693
 
694
694
  @validate_arguments
695
- def get_custom_entity_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
695
+ def get_custom_entity_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to retrieve. An entityType can be created using the \"CreateCustomEntityDefinition\" endpoint for CustomEntityDefinitions.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt datetime at which to retrieve the Custom Entity instance.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
696
696
  """GetCustomEntity: Get a Custom Entity instance. # noqa: E501
697
697
 
698
698
  Retrieve a Custom Entity instance by a specific entity type at a point in AsAt time. # noqa: E501
@@ -714,11 +714,11 @@ class CustomEntitiesApi:
714
714
  :type as_at: datetime
715
715
  :param effective_at: The effective datetime or cut label at which to get the Custom Entity instance. Defaults to the current LUSID system datetime if not specified.
716
716
  :type effective_at: str
717
- :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
717
+ :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
718
718
  :type related_entity_property_keys: List[str]
719
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
719
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entity in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
720
720
  :type relationship_definition_ids: List[str]
721
- :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
721
+ :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
722
722
  :type property_keys: List[str]
723
723
  :param async_req: Whether to execute the request asynchronously.
724
724
  :type async_req: bool, optional
@@ -1062,15 +1062,15 @@ class CustomEntitiesApi:
1062
1062
 
1063
1063
 
1064
1064
  @overload
1065
- async def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1065
+ async def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1066
1066
  ...
1067
1067
 
1068
1068
  @overload
1069
- def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1069
+ def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1070
1070
  ...
1071
1071
 
1072
1072
  @validate_arguments
1073
- def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
1073
+ def get_custom_entity_relationships(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
1074
1074
  """[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
1075
1075
 
1076
1076
  Get relationships for the specified Custom Entity. # noqa: E501
@@ -1094,7 +1094,7 @@ class CustomEntitiesApi:
1094
1094
  :type as_at: datetime
1095
1095
  :param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
1096
1096
  :type filter: str
1097
- :param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
1097
+ :param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
1098
1098
  :type identifier_types: List[str]
1099
1099
  :param async_req: Whether to execute the request asynchronously.
1100
1100
  :type async_req: bool, optional
@@ -1115,7 +1115,7 @@ class CustomEntitiesApi:
1115
1115
  return self.get_custom_entity_relationships_with_http_info(entity_type, identifier_scope, identifier_type, identifier_value, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
1116
1116
 
1117
1117
  @validate_arguments
1118
- def get_custom_entity_relationships_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1118
+ def get_custom_entity_relationships_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of entity get relationships for.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity.")], identifier_value : 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="Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1119
1119
  """[EARLY ACCESS] GetCustomEntityRelationships: Get Relationships for Custom Entity # noqa: E501
1120
1120
 
1121
1121
  Get relationships for the specified Custom Entity. # noqa: E501
@@ -1139,7 +1139,7 @@ class CustomEntitiesApi:
1139
1139
  :type as_at: datetime
1140
1140
  :param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
1141
1141
  :type filter: str
1142
- :param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
1142
+ :param identifier_types: Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relationships. If not applicable, provide an empty array.
1143
1143
  :type identifier_types: List[str]
1144
1144
  :param async_req: Whether to execute the request asynchronously.
1145
1145
  :type async_req: bool, optional
@@ -1274,15 +1274,15 @@ class CustomEntitiesApi:
1274
1274
 
1275
1275
 
1276
1276
  @overload
1277
- async def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
1277
+ async def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
1278
1278
  ...
1279
1279
 
1280
1280
  @overload
1281
- def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
1281
+ def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfCustomEntityResponse: # noqa: E501
1282
1282
  ...
1283
1283
 
1284
1284
  @validate_arguments
1285
- def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityResponse, Awaitable[PagedResourceListOfCustomEntityResponse]]: # noqa: E501
1285
+ def list_custom_entities(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfCustomEntityResponse, Awaitable[PagedResourceListOfCustomEntityResponse]]: # noqa: E501
1286
1286
  """ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
1287
1287
 
1288
1288
  List all the Custom Entities matching particular criteria. # noqa: E501
@@ -1294,23 +1294,23 @@ class CustomEntitiesApi:
1294
1294
 
1295
1295
  :param entity_type: The type of Custom Entity to list. (required)
1296
1296
  :type entity_type: str
1297
- :param effective_at: The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
1297
+ :param effective_at: The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
1298
1298
  :type effective_at: str
1299
- :param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
1299
+ :param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
1300
1300
  :type as_at: datetime
1301
1301
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1302
1302
  :type limit: int
1303
- :param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1303
+ :param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1304
1304
  :type filter: str
1305
1305
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1306
1306
  :type sort_by: List[str]
1307
- :param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1307
+ :param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1308
1308
  :type page: str
1309
- :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
1309
+ :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
1310
1310
  :type related_entity_property_keys: List[str]
1311
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1311
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1312
1312
  :type relationship_definition_ids: List[str]
1313
- :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
1313
+ :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
1314
1314
  :type property_keys: List[str]
1315
1315
  :param async_req: Whether to execute the request asynchronously.
1316
1316
  :type async_req: bool, optional
@@ -1331,7 +1331,7 @@ class CustomEntitiesApi:
1331
1331
  return self.list_custom_entities_with_http_info(entity_type, effective_at, as_at, limit, filter, sort_by, page, related_entity_property_keys, relationship_definition_ids, property_keys, **kwargs) # noqa: E501
1332
1332
 
1333
1333
  @validate_arguments
1334
- def list_custom_entities_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1334
+ def list_custom_entities_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of Custom Entity to list.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the entities. 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 entities. Defaults to returning the latest version of each portfolio if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, related_entity_property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1335
1335
  """ListCustomEntities: List Custom Entities of the specified entityType. # noqa: E501
1336
1336
 
1337
1337
  List all the Custom Entities matching particular criteria. # noqa: E501
@@ -1343,23 +1343,23 @@ class CustomEntitiesApi:
1343
1343
 
1344
1344
  :param entity_type: The type of Custom Entity to list. (required)
1345
1345
  :type entity_type: str
1346
- :param effective_at: The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
1346
+ :param effective_at: The effective datetime or cut label at which to list the entities. Defaults to the current LUSID system datetime if not specified.
1347
1347
  :type effective_at: str
1348
- :param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
1348
+ :param as_at: The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
1349
1349
  :type as_at: datetime
1350
1350
  :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1351
1351
  :type limit: int
1352
- :param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1352
+ :param filter: Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1353
1353
  :type filter: str
1354
1354
  :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\".
1355
1355
  :type sort_by: List[str]
1356
- :param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1356
+ :param page: The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.
1357
1357
  :type page: str
1358
- :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
1358
+ :param related_entity_property_keys: A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
1359
1359
  :type related_entity_property_keys: List[str]
1360
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1360
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the entities in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1361
1361
  :type relationship_definition_ids: List[str]
1362
- :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
1362
+ :param property_keys: A list of property keys from the 'CustomEntity' domain to decorate onto the custom entities of any type supported by that property (defined within the property definition CustomEntityTypes). These must have the format {domain}/{scope}/{code}, for example 'CustomEntity/someScope/id'.
1363
1363
  :type property_keys: List[str]
1364
1364
  :param async_req: Whether to execute the request asynchronously.
1365
1365
  :type async_req: bool, optional
@@ -1516,7 +1516,7 @@ class CustomEntitiesApi:
1516
1516
  def patch_custom_entity_access_metadata(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
1517
1517
  """[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501
1518
1518
 
1519
- Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
1519
+ Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
1520
1520
  This method makes a synchronous HTTP request by default. To make an
1521
1521
  asynchronous HTTP request, please pass async_req=True
1522
1522
 
@@ -1559,7 +1559,7 @@ class CustomEntitiesApi:
1559
1559
  def patch_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
1560
1560
  """[EARLY ACCESS] PatchCustomEntityAccessMetadata: Patch Access Metadata rules for a Custom Entity. # noqa: E501
1561
1561
 
1562
- Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
1562
+ Patch Custom Entity Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document Currently only valid metadata keys are supported paths on the patch document The response will return any affected Custom Entity Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
1563
1563
  This method makes a synchronous HTTP request by default. To make an
1564
1564
  asynchronous HTTP request, please pass async_req=True
1565
1565
 
@@ -2068,7 +2068,7 @@ class CustomEntitiesApi:
2068
2068
  def upsert_custom_entity_access_metadata(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
2069
2069
  """[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
2070
2070
 
2071
- Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
2071
+ Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
2072
2072
  This method makes a synchronous HTTP request by default. To make an
2073
2073
  asynchronous HTTP request, please pass async_req=True
2074
2074
 
@@ -2113,7 +2113,7 @@ class CustomEntitiesApi:
2113
2113
  def upsert_custom_entity_access_metadata_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The type of the Custom Entity.")], identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Custom Entity instance.")], identifier_value : Annotated[StrictStr, Field(..., description="The identifier value.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], identifier_scope : Annotated[StrictStr, Field(..., description="The identifier scope.")], upsert_custom_entity_access_metadata_request : Annotated[UpsertCustomEntityAccessMetadataRequest, Field(..., description="The Custom Entity Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which the Access Metadata will be effective from")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
2114
2114
  """[EARLY ACCESS] UpsertCustomEntityAccessMetadata: Upsert a Custom Entity Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
2115
2115
 
2116
- Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
2116
+ Update or insert one Custom Entity Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Custom Entity Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. # noqa: E501
2117
2117
  This method makes a synchronous HTTP request by default. To make an
2118
2118
  asynchronous HTTP request, please pass async_req=True
2119
2119