lusid-sdk 2.1.911__py3-none-any.whl → 2.1.913__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 (333) 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/transaction_settlement_instruction.py +5 -3
  310. lusid/models/translate_entities_inlined_request.py +1 -1
  311. lusid/models/translate_entities_request.py +1 -1
  312. lusid/models/translate_instrument_definitions_request.py +1 -1
  313. lusid/models/translate_trade_ticket_request.py +1 -1
  314. lusid/models/translation_input.py +1 -1
  315. lusid/models/trigger_event.py +1 -1
  316. lusid/models/typed_resource_id.py +2 -2
  317. lusid/models/unmatched_holding_method.py +1 -1
  318. lusid/models/upsert_cds_flow_conventions_request.py +1 -1
  319. lusid/models/upsert_counterparty_agreement_request.py +1 -1
  320. lusid/models/upsert_flow_conventions_request.py +1 -1
  321. lusid/models/upsert_index_convention_request.py +1 -1
  322. lusid/models/upsert_quote_request.py +1 -1
  323. lusid/models/upsert_recipe_request.py +1 -1
  324. lusid/models/valuation_request.py +5 -5
  325. lusid/models/valuation_schedule.py +5 -5
  326. lusid/models/valuations_reconciliation_request.py +2 -2
  327. lusid/models/vendor_model_rule.py +3 -3
  328. lusid/models/virtual_document.py +1 -1
  329. lusid/models/weighted_instrument.py +2 -2
  330. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +1 -1
  331. {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/METADATA +3 -3
  332. {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/RECORD +333 -333
  333. {lusid_sdk-2.1.911.dist-info → lusid_sdk-2.1.913.dist-info}/WHEEL +0 -0
lusid/api/persons_api.py CHANGED
@@ -69,18 +69,18 @@ class PersonsApi:
69
69
 
70
70
 
71
71
  @overload
72
- async def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
72
+ async def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], **kwargs) -> DeletedEntityResponse: # noqa: E501
73
73
  ...
74
74
 
75
75
  @overload
76
- def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
76
+ def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
77
77
  ...
78
78
 
79
79
  @validate_arguments
80
- def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
80
+ def delete_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
81
81
  """DeletePerson: Delete person # noqa: E501
82
82
 
83
- Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
83
+ Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
84
84
  This method makes a synchronous HTTP request by default. To make an
85
85
  asynchronous HTTP request, please pass async_req=True
86
86
 
@@ -91,7 +91,7 @@ class PersonsApi:
91
91
  :type id_type_scope: str
92
92
  :param id_type_code: The code of the person identifier type. (required)
93
93
  :type id_type_code: str
94
- :param code: Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (required)
94
+ :param code: Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (required)
95
95
  :type code: str
96
96
  :param async_req: Whether to execute the request asynchronously.
97
97
  :type async_req: bool, optional
@@ -112,10 +112,10 @@ class PersonsApi:
112
112
  return self.delete_person_with_http_info(id_type_scope, id_type_code, code, **kwargs) # noqa: E501
113
113
 
114
114
  @validate_arguments
115
- def delete_person_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], **kwargs) -> ApiResponse: # noqa: E501
115
+ def delete_person_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="The scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="The code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.")], **kwargs) -> ApiResponse: # noqa: E501
116
116
  """DeletePerson: Delete person # noqa: E501
117
117
 
118
- Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
118
+ Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
119
119
  This method makes a synchronous HTTP request by default. To make an
120
120
  asynchronous HTTP request, please pass async_req=True
121
121
 
@@ -126,7 +126,7 @@ class PersonsApi:
126
126
  :type id_type_scope: str
127
127
  :param id_type_code: The code of the person identifier type. (required)
128
128
  :type id_type_code: str
129
- :param code: Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (required)
129
+ :param code: Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. (required)
130
130
  :type code: str
131
131
  :param async_req: Whether to execute the request asynchronously.
132
132
  :type async_req: bool, optional
@@ -248,7 +248,7 @@ class PersonsApi:
248
248
  def delete_person_access_metadata(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
249
249
  """[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
250
250
 
251
- Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
251
+ Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
252
252
  This method makes a synchronous HTTP request by default. To make an
253
253
  asynchronous HTTP request, please pass async_req=True
254
254
 
@@ -289,7 +289,7 @@ class PersonsApi:
289
289
  def delete_person_access_metadata_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective date to delete at, if this is not supplied, it will delete all data found")] = None, effective_until : Annotated[Optional[datetime], Field(description="The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
290
290
  """[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry # noqa: E501
291
291
 
292
- Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
292
+ Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). # noqa: E501
293
293
  This method makes a synchronous HTTP request by default. To make an
294
294
  asynchronous HTTP request, please pass async_req=True
295
295
 
@@ -432,15 +432,15 @@ class PersonsApi:
432
432
 
433
433
 
434
434
  @overload
435
- async def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
435
+ async def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
436
436
  ...
437
437
 
438
438
  @overload
439
- def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
439
+ def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
440
440
  ...
441
441
 
442
442
  @validate_arguments
443
- def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
443
+ def delete_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
444
444
  """[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
445
445
 
446
446
  Delete identifiers that belong to the given property keys of the person. # noqa: E501
@@ -454,11 +454,11 @@ class PersonsApi:
454
454
  :type id_type_scope: str
455
455
  :param id_type_code: Code of the person identifier type. (required)
456
456
  :type id_type_code: str
457
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
457
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
458
458
  :type code: str
459
- :param property_keys: The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed. (required)
459
+ :param property_keys: The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed. (required)
460
460
  :type property_keys: List[str]
461
- :param effective_at: The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
461
+ :param effective_at: The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
462
462
  :type effective_at: str
463
463
  :param async_req: Whether to execute the request asynchronously.
464
464
  :type async_req: bool, optional
@@ -479,7 +479,7 @@ class PersonsApi:
479
479
  return self.delete_person_identifiers_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, **kwargs) # noqa: E501
480
480
 
481
481
  @validate_arguments
482
- def delete_person_identifiers_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
482
+ def delete_person_identifiers_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
483
483
  """[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers # noqa: E501
484
484
 
485
485
  Delete identifiers that belong to the given property keys of the person. # noqa: E501
@@ -493,11 +493,11 @@ class PersonsApi:
493
493
  :type id_type_scope: str
494
494
  :param id_type_code: Code of the person identifier type. (required)
495
495
  :type id_type_code: str
496
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
496
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
497
497
  :type code: str
498
- :param property_keys: The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed. (required)
498
+ :param property_keys: The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed. (required)
499
499
  :type property_keys: List[str]
500
- :param effective_at: The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
500
+ :param effective_at: The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
501
501
  :type effective_at: str
502
502
  :param async_req: Whether to execute the request asynchronously.
503
503
  :type async_req: bool, optional
@@ -617,15 +617,15 @@ class PersonsApi:
617
617
 
618
618
 
619
619
  @overload
620
- async def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
620
+ async def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> DeletedEntityResponse: # noqa: E501
621
621
  ...
622
622
 
623
623
  @overload
624
- def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
624
+ def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
625
625
  ...
626
626
 
627
627
  @validate_arguments
628
- def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
628
+ def delete_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
629
629
  """[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
630
630
 
631
631
  Delete all properties that belong to the given property keys of the person. # noqa: E501
@@ -639,11 +639,11 @@ class PersonsApi:
639
639
  :type id_type_scope: str
640
640
  :param id_type_code: Code of the person identifier type. (required)
641
641
  :type id_type_code: str
642
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
642
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
643
643
  :type code: str
644
- :param property_keys: The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed. (required)
644
+ :param property_keys: The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed. (required)
645
645
  :type property_keys: List[str]
646
- :param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
646
+ :param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
647
647
  :type effective_at: str
648
648
  :param async_req: Whether to execute the request asynchronously.
649
649
  :type async_req: bool, optional
@@ -664,7 +664,7 @@ class PersonsApi:
664
664
  return self.delete_person_properties_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, **kwargs) # noqa: E501
665
665
 
666
666
  @validate_arguments
667
- def delete_person_properties_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
667
+ def delete_person_properties_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[conlist(StrictStr), Field(..., description="The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, **kwargs) -> ApiResponse: # noqa: E501
668
668
  """[EARLY ACCESS] DeletePersonProperties: Delete Person Properties # noqa: E501
669
669
 
670
670
  Delete all properties that belong to the given property keys of the person. # noqa: E501
@@ -678,11 +678,11 @@ class PersonsApi:
678
678
  :type id_type_scope: str
679
679
  :param id_type_code: Code of the person identifier type. (required)
680
680
  :type id_type_code: str
681
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
681
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
682
682
  :type code: str
683
- :param property_keys: The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed. (required)
683
+ :param property_keys: The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed. (required)
684
684
  :type property_keys: List[str]
685
- :param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
685
+ :param effective_at: The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
686
686
  :type effective_at: str
687
687
  :param async_req: Whether to execute the request asynchronously.
688
688
  :type async_req: bool, optional
@@ -989,15 +989,15 @@ class PersonsApi:
989
989
 
990
990
 
991
991
  @overload
992
- async def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> Person: # noqa: E501
992
+ async def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> Person: # noqa: E501
993
993
  ...
994
994
 
995
995
  @overload
996
- def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
996
+ def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
997
997
  ...
998
998
 
999
999
  @validate_arguments
1000
- def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
1000
+ def get_person(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
1001
1001
  """[EARLY ACCESS] GetPerson: Get Person # noqa: E501
1002
1002
 
1003
1003
  Retrieve the definition of a person. # noqa: E501
@@ -1011,15 +1011,15 @@ class PersonsApi:
1011
1011
  :type id_type_scope: str
1012
1012
  :param id_type_code: Code of the person identifier type. (required)
1013
1013
  :type id_type_code: str
1014
- :param code: Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
1014
+ :param code: Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
1015
1015
  :type code: str
1016
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
1016
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
1017
1017
  :type property_keys: List[str]
1018
1018
  :param effective_at: The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.
1019
1019
  :type effective_at: str
1020
1020
  :param as_at: The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.
1021
1021
  :type as_at: datetime
1022
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1022
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1023
1023
  :type relationship_definition_ids: List[str]
1024
1024
  :param async_req: Whether to execute the request asynchronously.
1025
1025
  :type async_req: bool, optional
@@ -1040,7 +1040,7 @@ class PersonsApi:
1040
1040
  return self.get_person_with_http_info(id_type_scope, id_type_code, code, property_keys, effective_at, as_at, relationship_definition_ids, **kwargs) # noqa: E501
1041
1041
 
1042
1042
  @validate_arguments
1043
- def get_person_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1043
+ def get_person_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.")], property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1044
1044
  """[EARLY ACCESS] GetPerson: Get Person # noqa: E501
1045
1045
 
1046
1046
  Retrieve the definition of a person. # noqa: E501
@@ -1054,15 +1054,15 @@ class PersonsApi:
1054
1054
  :type id_type_scope: str
1055
1055
  :param id_type_code: Code of the person identifier type. (required)
1056
1056
  :type id_type_code: str
1057
- :param code: Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
1057
+ :param code: Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. (required)
1058
1058
  :type code: str
1059
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
1059
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
1060
1060
  :type property_keys: List[str]
1061
1061
  :param effective_at: The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.
1062
1062
  :type effective_at: str
1063
1063
  :param as_at: The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.
1064
1064
  :type as_at: datetime
1065
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1065
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
1066
1066
  :type relationship_definition_ids: List[str]
1067
1067
  :param async_req: Whether to execute the request asynchronously.
1068
1068
  :type async_req: bool, optional
@@ -1205,7 +1205,7 @@ class PersonsApi:
1205
1205
  def get_person_access_metadata_by_key(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Access Metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[List[AccessMetadataValue], Awaitable[List[AccessMetadataValue]]]: # noqa: E501
1206
1206
  """[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
1207
1207
 
1208
- Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501
1208
+ Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501
1209
1209
  This method makes a synchronous HTTP request by default. To make an
1210
1210
  asynchronous HTTP request, please pass async_req=True
1211
1211
 
@@ -1246,7 +1246,7 @@ class PersonsApi:
1246
1246
  def get_person_access_metadata_by_key_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to retrieve the Access Metadata")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Access Metadata")] = None, **kwargs) -> ApiResponse: # noqa: E501
1247
1247
  """[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person # noqa: E501
1248
1248
 
1249
- Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501
1249
+ Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry # noqa: E501
1250
1250
  This method makes a synchronous HTTP request by default. To make an
1251
1251
  asynchronous HTTP request, please pass async_req=True
1252
1252
 
@@ -1389,15 +1389,15 @@ class PersonsApi:
1389
1389
 
1390
1390
 
1391
1391
  @overload
1392
- async def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
1392
+ async def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
1393
1393
  ...
1394
1394
 
1395
1395
  @overload
1396
- def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
1396
+ def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPropertyInterval: # noqa: E501
1397
1397
  ...
1398
1398
 
1399
1399
  @validate_arguments
1400
- def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
1400
+ def get_person_property_time_series(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPropertyInterval, Awaitable[ResourceListOfPropertyInterval]]: # noqa: E501
1401
1401
  """[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
1402
1402
 
1403
1403
  List the complete time series of a person property. # noqa: E501
@@ -1413,13 +1413,13 @@ class PersonsApi:
1413
1413
  :type id_type_code: str
1414
1414
  :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1415
1415
  :type code: str
1416
- :param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. (required)
1416
+ :param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. (required)
1417
1417
  :type property_key: str
1418
1418
  :param as_at: The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.
1419
1419
  :type as_at: datetime
1420
1420
  :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
1421
1421
  :type filter: str
1422
- :param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
1422
+ :param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
1423
1423
  :type page: str
1424
1424
  :param limit: When paginating, limit the number of returned results to this many.
1425
1425
  :type limit: int
@@ -1442,7 +1442,7 @@ class PersonsApi:
1442
1442
  return self.get_person_property_time_series_with_http_info(id_type_scope, id_type_code, code, property_key, as_at, filter, page, limit, **kwargs) # noqa: E501
1443
1443
 
1444
1444
  @validate_arguments
1445
- def get_person_property_time_series_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1445
+ def get_person_property_time_series_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], property_key : Annotated[StrictStr, Field(..., description="The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1446
1446
  """[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series # noqa: E501
1447
1447
 
1448
1448
  List the complete time series of a person property. # noqa: E501
@@ -1458,13 +1458,13 @@ class PersonsApi:
1458
1458
  :type id_type_code: str
1459
1459
  :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1460
1460
  :type code: str
1461
- :param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. (required)
1461
+ :param property_key: The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. (required)
1462
1462
  :type property_key: str
1463
1463
  :param as_at: The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.
1464
1464
  :type as_at: datetime
1465
1465
  :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
1466
1466
  :type filter: str
1467
- :param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
1467
+ :param page: The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
1468
1468
  :type page: str
1469
1469
  :param limit: When paginating, limit the number of returned results to this many.
1470
1470
  :type limit: int
@@ -1600,15 +1600,15 @@ class PersonsApi:
1600
1600
 
1601
1601
 
1602
1602
  @overload
1603
- async def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelation: # noqa: E501
1603
+ async def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ResourceListOfRelation: # noqa: E501
1604
1604
  ...
1605
1605
 
1606
1606
  @overload
1607
- def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelation: # noqa: E501
1607
+ def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelation: # noqa: E501
1608
1608
  ...
1609
1609
 
1610
1610
  @validate_arguments
1611
- def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelation, Awaitable[ResourceListOfRelation]]: # noqa: E501
1611
+ def get_person_relations(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelation, Awaitable[ResourceListOfRelation]]: # noqa: E501
1612
1612
  """[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
1613
1613
 
1614
1614
  Get relations for the specified person. # noqa: E501
@@ -1622,7 +1622,7 @@ class PersonsApi:
1622
1622
  :type id_type_scope: str
1623
1623
  :param id_type_code: Code of the person identifier type. (required)
1624
1624
  :type id_type_code: str
1625
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1625
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1626
1626
  :type code: str
1627
1627
  :param effective_at: The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
1628
1628
  :type effective_at: str
@@ -1630,7 +1630,7 @@ class PersonsApi:
1630
1630
  :type as_at: datetime
1631
1631
  :param filter: Expression to filter the relations. Users should provide null or empty string for this field until further notice.
1632
1632
  :type filter: str
1633
- :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 relations. If not applicable, provide an empty array.
1633
+ :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 relations. If not applicable, provide an empty array.
1634
1634
  :type identifier_types: List[str]
1635
1635
  :param async_req: Whether to execute the request asynchronously.
1636
1636
  :type async_req: bool, optional
@@ -1651,7 +1651,7 @@ class PersonsApi:
1651
1651
  return self.get_person_relations_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
1652
1652
 
1653
1653
  @validate_arguments
1654
- def get_person_relations_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1654
+ def get_person_relations_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the relations. 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 relations. If not applicable, provide an empty array.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1655
1655
  """[EARLY ACCESS] GetPersonRelations: Get Relations for Person # noqa: E501
1656
1656
 
1657
1657
  Get relations for the specified person. # noqa: E501
@@ -1665,7 +1665,7 @@ class PersonsApi:
1665
1665
  :type id_type_scope: str
1666
1666
  :param id_type_code: Code of the person identifier type. (required)
1667
1667
  :type id_type_code: str
1668
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1668
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1669
1669
  :type code: str
1670
1670
  :param effective_at: The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
1671
1671
  :type effective_at: str
@@ -1673,7 +1673,7 @@ class PersonsApi:
1673
1673
  :type as_at: datetime
1674
1674
  :param filter: Expression to filter the relations. Users should provide null or empty string for this field until further notice.
1675
1675
  :type filter: str
1676
- :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 relations. If not applicable, provide an empty array.
1676
+ :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 relations. If not applicable, provide an empty array.
1677
1677
  :type identifier_types: List[str]
1678
1678
  :param async_req: Whether to execute the request asynchronously.
1679
1679
  :type async_req: bool, optional
@@ -1804,15 +1804,15 @@ class PersonsApi:
1804
1804
 
1805
1805
 
1806
1806
  @overload
1807
- async def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1807
+ async def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1808
1808
  ...
1809
1809
 
1810
1810
  @overload
1811
- def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1811
+ def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfRelationship: # noqa: E501
1812
1812
  ...
1813
1813
 
1814
1814
  @validate_arguments
1815
- def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
1815
+ def get_person_relationships(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
1816
1816
  """[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
1817
1817
 
1818
1818
  Get relationships for the specified person. # noqa: E501
@@ -1826,7 +1826,7 @@ class PersonsApi:
1826
1826
  :type id_type_scope: str
1827
1827
  :param id_type_code: Code of the person's identifier type. (required)
1828
1828
  :type id_type_code: str
1829
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1829
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1830
1830
  :type code: str
1831
1831
  :param effective_at: The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
1832
1832
  :type effective_at: str
@@ -1834,7 +1834,7 @@ class PersonsApi:
1834
1834
  :type as_at: datetime
1835
1835
  :param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
1836
1836
  :type filter: str
1837
- :param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
1837
+ :param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
1838
1838
  :type identifier_types: List[str]
1839
1839
  :param async_req: Whether to execute the request asynchronously.
1840
1840
  :type async_req: bool, optional
@@ -1855,7 +1855,7 @@ class PersonsApi:
1855
1855
  return self.get_person_relationships_with_http_info(id_type_scope, id_type_code, code, effective_at, as_at, filter, identifier_types, **kwargs) # noqa: E501
1856
1856
 
1857
1857
  @validate_arguments
1858
- def get_person_relationships_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1858
+ def get_person_relationships_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person's identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person's identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1859
1859
  """[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person # noqa: E501
1860
1860
 
1861
1861
  Get relationships for the specified person. # noqa: E501
@@ -1869,7 +1869,7 @@ class PersonsApi:
1869
1869
  :type id_type_scope: str
1870
1870
  :param id_type_code: Code of the person's identifier type. (required)
1871
1871
  :type id_type_code: str
1872
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1872
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
1873
1873
  :type code: str
1874
1874
  :param effective_at: The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
1875
1875
  :type effective_at: str
@@ -1877,7 +1877,7 @@ class PersonsApi:
1877
1877
  :type as_at: datetime
1878
1878
  :param filter: Expression to filter relationships. Users should provide null or empty string for this field until further notice.
1879
1879
  :type filter: str
1880
- :param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
1880
+ :param identifier_types: Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
1881
1881
  :type identifier_types: List[str]
1882
1882
  :param async_req: Whether to execute the request asynchronously.
1883
1883
  :type async_req: bool, optional
@@ -2008,15 +2008,15 @@ class PersonsApi:
2008
2008
 
2009
2009
 
2010
2010
  @overload
2011
- async def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ResourceListOfPerson: # noqa: E501
2011
+ async def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ResourceListOfPerson: # noqa: E501
2012
2012
  ...
2013
2013
 
2014
2014
  @overload
2015
- def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPerson: # noqa: E501
2015
+ def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfPerson: # noqa: E501
2016
2016
  ...
2017
2017
 
2018
2018
  @validate_arguments
2019
- def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPerson, Awaitable[ResourceListOfPerson]]: # noqa: E501
2019
+ def list_all_persons(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPerson, Awaitable[ResourceListOfPerson]]: # noqa: E501
2020
2020
  """[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
2021
2021
 
2022
2022
  List all persons which the user is entitled to see. # noqa: E501
@@ -2026,19 +2026,19 @@ class PersonsApi:
2026
2026
  >>> thread = api.list_all_persons(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True)
2027
2027
  >>> result = thread.get()
2028
2028
 
2029
- :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2029
+ :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2030
2030
  :type effective_at: str
2031
- :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2031
+ :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2032
2032
  :type as_at: datetime
2033
- :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2033
+ :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2034
2034
  :type page: str
2035
2035
  :param limit: When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
2036
2036
  :type limit: int
2037
- :param filter: Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2037
+ :param filter: Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2038
2038
  :type filter: str
2039
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2039
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2040
2040
  :type property_keys: List[str]
2041
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2041
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2042
2042
  :type relationship_definition_ids: List[str]
2043
2043
  :param async_req: Whether to execute the request asynchronously.
2044
2044
  :type async_req: bool, optional
@@ -2059,7 +2059,7 @@ class PersonsApi:
2059
2059
  return self.list_all_persons_with_http_info(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
2060
2060
 
2061
2061
  @validate_arguments
2062
- def list_all_persons_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2062
+ def list_all_persons_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2063
2063
  """[EARLY ACCESS] ListAllPersons: List All Persons # noqa: E501
2064
2064
 
2065
2065
  List all persons which the user is entitled to see. # noqa: E501
@@ -2069,19 +2069,19 @@ class PersonsApi:
2069
2069
  >>> thread = api.list_all_persons_with_http_info(effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, async_req=True)
2070
2070
  >>> result = thread.get()
2071
2071
 
2072
- :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2072
+ :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2073
2073
  :type effective_at: str
2074
- :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2074
+ :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2075
2075
  :type as_at: datetime
2076
- :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2076
+ :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2077
2077
  :type page: str
2078
2078
  :param limit: When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
2079
2079
  :type limit: int
2080
- :param filter: Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2080
+ :param filter: Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2081
2081
  :type filter: str
2082
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2082
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2083
2083
  :type property_keys: List[str]
2084
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2084
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2085
2085
  :type relationship_definition_ids: List[str]
2086
2086
  :param async_req: Whether to execute the request asynchronously.
2087
2087
  :type async_req: bool, optional
@@ -2213,15 +2213,15 @@ class PersonsApi:
2213
2213
 
2214
2214
 
2215
2215
  @overload
2216
- async def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
2216
+ async def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
2217
2217
  ...
2218
2218
 
2219
2219
  @overload
2220
- def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
2220
+ def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPerson: # noqa: E501
2221
2221
  ...
2222
2222
 
2223
2223
  @validate_arguments
2224
- def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPerson, Awaitable[PagedResourceListOfPerson]]: # noqa: E501
2224
+ def list_persons(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPerson, Awaitable[PagedResourceListOfPerson]]: # noqa: E501
2225
2225
  """[EARLY ACCESS] ListPersons: List Persons # noqa: E501
2226
2226
 
2227
2227
  List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
@@ -2235,19 +2235,19 @@ class PersonsApi:
2235
2235
  :type id_type_scope: str
2236
2236
  :param id_type_code: Code of the person identifier type. (required)
2237
2237
  :type id_type_code: str
2238
- :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2238
+ :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2239
2239
  :type effective_at: str
2240
- :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2240
+ :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2241
2241
  :type as_at: datetime
2242
- :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2242
+ :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2243
2243
  :type page: str
2244
2244
  :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
2245
2245
  :type limit: int
2246
- :param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2246
+ :param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2247
2247
  :type filter: str
2248
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2248
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2249
2249
  :type property_keys: List[str]
2250
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2250
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2251
2251
  :type relationship_definition_ids: List[str]
2252
2252
  :param async_req: Whether to execute the request asynchronously.
2253
2253
  :type async_req: bool, optional
@@ -2268,7 +2268,7 @@ class PersonsApi:
2268
2268
  return self.list_persons_with_http_info(id_type_scope, id_type_code, effective_at, as_at, page, limit, filter, property_keys, relationship_definition_ids, **kwargs) # noqa: E501
2269
2269
 
2270
2270
  @validate_arguments
2271
- def list_persons_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2271
+ def list_persons_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the people. 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 people. Defaults to return the latest version of each people if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".")] = None, relationship_definition_ids : Annotated[Optional[conlist(StrictStr)], Field(description="A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2272
2272
  """[EARLY ACCESS] ListPersons: List Persons # noqa: E501
2273
2273
 
2274
2274
  List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria. # noqa: E501
@@ -2282,19 +2282,19 @@ class PersonsApi:
2282
2282
  :type id_type_scope: str
2283
2283
  :param id_type_code: Code of the person identifier type. (required)
2284
2284
  :type id_type_code: str
2285
- :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2285
+ :param effective_at: The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
2286
2286
  :type effective_at: str
2287
- :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2287
+ :param as_at: The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
2288
2288
  :type as_at: datetime
2289
- :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2289
+ :param page: The pagination token to use to continue listing persons from a previous call to list persons. 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.
2290
2290
  :type page: str
2291
2291
  :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
2292
2292
  :type limit: int
2293
- :param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2293
+ :param filter: Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
2294
2294
  :type filter: str
2295
- :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2295
+ :param property_keys: A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
2296
2296
  :type property_keys: List[str]
2297
- :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2297
+ :param relationship_definition_ids: A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
2298
2298
  :type relationship_definition_ids: List[str]
2299
2299
  :param async_req: Whether to execute the request asynchronously.
2300
2300
  :type async_req: bool, optional
@@ -2445,7 +2445,7 @@ class PersonsApi:
2445
2445
  def patch_person_access_metadata(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to upsert 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[Dict[str, List[AccessMetadataValue]], Awaitable[Dict[str, List[AccessMetadataValue]]]]: # noqa: E501
2446
2446
  """[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. # noqa: E501
2447
2447
 
2448
- Patch Person 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 Person 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
2448
+ Patch Person 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 Person 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
2449
2449
  This method makes a synchronous HTTP request by default. To make an
2450
2450
  asynchronous HTTP request, please pass async_req=True
2451
2451
 
@@ -2486,7 +2486,7 @@ class PersonsApi:
2486
2486
  def patch_person_access_metadata_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], access_metadata_operation : Annotated[conlist(AccessMetadataOperation), Field(..., description="The Json Patch document")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to upsert 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
2487
2487
  """[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. # noqa: E501
2488
2488
 
2489
- Patch Person 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 Person 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
2489
+ Patch Person 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 Person 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
2490
2490
  This method makes a synchronous HTTP request by default. To make an
2491
2491
  asynchronous HTTP request, please pass async_req=True
2492
2492
 
@@ -2636,15 +2636,15 @@ class PersonsApi:
2636
2636
 
2637
2637
 
2638
2638
  @overload
2639
- async def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], **kwargs) -> Person: # noqa: E501
2639
+ async def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], **kwargs) -> Person: # noqa: E501
2640
2640
  ...
2641
2641
 
2642
2642
  @overload
2643
- def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
2643
+ def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
2644
2644
  ...
2645
2645
 
2646
2646
  @validate_arguments
2647
- def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
2647
+ def set_person_identifiers(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
2648
2648
  """[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
2649
2649
 
2650
2650
  Set identifiers of the person. # noqa: E501
@@ -2658,7 +2658,7 @@ class PersonsApi:
2658
2658
  :type id_type_scope: str
2659
2659
  :param id_type_code: Code of the person identifier type. (required)
2660
2660
  :type id_type_code: str
2661
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2661
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2662
2662
  :type code: str
2663
2663
  :param set_person_identifiers_request: Request containing identifiers to set for the person. Identifiers not specified in request will not be changed. (required)
2664
2664
  :type set_person_identifiers_request: SetPersonIdentifiersRequest
@@ -2681,7 +2681,7 @@ class PersonsApi:
2681
2681
  return self.set_person_identifiers_with_http_info(id_type_scope, id_type_code, code, set_person_identifiers_request, **kwargs) # noqa: E501
2682
2682
 
2683
2683
  @validate_arguments
2684
- def set_person_identifiers_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], **kwargs) -> ApiResponse: # noqa: E501
2684
+ def set_person_identifiers_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_identifiers_request : Annotated[SetPersonIdentifiersRequest, Field(..., description="Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.")], **kwargs) -> ApiResponse: # noqa: E501
2685
2685
  """[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers # noqa: E501
2686
2686
 
2687
2687
  Set identifiers of the person. # noqa: E501
@@ -2695,7 +2695,7 @@ class PersonsApi:
2695
2695
  :type id_type_scope: str
2696
2696
  :param id_type_code: Code of the person identifier type. (required)
2697
2697
  :type id_type_code: str
2698
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2698
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2699
2699
  :type code: str
2700
2700
  :param set_person_identifiers_request: Request containing identifiers to set for the person. Identifiers not specified in request will not be changed. (required)
2701
2701
  :type set_person_identifiers_request: SetPersonIdentifiersRequest
@@ -2819,15 +2819,15 @@ class PersonsApi:
2819
2819
 
2820
2820
 
2821
2821
  @overload
2822
- async def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], **kwargs) -> Person: # noqa: E501
2822
+ async def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], **kwargs) -> Person: # noqa: E501
2823
2823
  ...
2824
2824
 
2825
2825
  @overload
2826
- def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
2826
+ def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], async_req: Optional[bool]=True, **kwargs) -> Person: # noqa: E501
2827
2827
  ...
2828
2828
 
2829
2829
  @validate_arguments
2830
- def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
2830
+ def set_person_properties(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], async_req: Optional[bool]=None, **kwargs) -> Union[Person, Awaitable[Person]]: # noqa: E501
2831
2831
  """[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
2832
2832
 
2833
2833
  Set properties of the person. # noqa: E501
@@ -2841,7 +2841,7 @@ class PersonsApi:
2841
2841
  :type id_type_scope: str
2842
2842
  :param id_type_code: Code of the person identifier type. (required)
2843
2843
  :type id_type_code: str
2844
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2844
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2845
2845
  :type code: str
2846
2846
  :param set_person_properties_request: Request containing properties to set for the person. Properties not specified in request will not be changed. (required)
2847
2847
  :type set_person_properties_request: SetPersonPropertiesRequest
@@ -2864,7 +2864,7 @@ class PersonsApi:
2864
2864
  return self.set_person_properties_with_http_info(id_type_scope, id_type_code, code, set_person_properties_request, **kwargs) # noqa: E501
2865
2865
 
2866
2866
  @validate_arguments
2867
- def set_person_properties_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], **kwargs) -> ApiResponse: # noqa: E501
2867
+ def set_person_properties_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier type.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier type.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.")], set_person_properties_request : Annotated[SetPersonPropertiesRequest, Field(..., description="Request containing properties to set for the person. Properties not specified in request will not be changed.")], **kwargs) -> ApiResponse: # noqa: E501
2868
2868
  """[EARLY ACCESS] SetPersonProperties: Set Person Properties # noqa: E501
2869
2869
 
2870
2870
  Set properties of the person. # noqa: E501
@@ -2878,7 +2878,7 @@ class PersonsApi:
2878
2878
  :type id_type_scope: str
2879
2879
  :param id_type_code: Code of the person identifier type. (required)
2880
2880
  :type id_type_code: str
2881
- :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2881
+ :param code: Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. (required)
2882
2882
  :type code: str
2883
2883
  :param set_person_properties_request: Request containing properties to set for the person. Properties not specified in request will not be changed. (required)
2884
2884
  :type set_person_properties_request: SetPersonPropertiesRequest
@@ -3172,7 +3172,7 @@ class PersonsApi:
3172
3172
  def upsert_person_access_metadata(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], upsert_person_access_metadata_request : Annotated[UpsertPersonAccessMetadataRequest, Field(..., description="The Person Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to upsert 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[ResourceListOfAccessMetadataValueOf, Awaitable[ResourceListOfAccessMetadataValueOf]]: # noqa: E501
3173
3173
  """[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
3174
3174
 
3175
- Update or insert one Person 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 Person 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
3175
+ Update or insert one Person 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 Person 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
3176
3176
  This method makes a synchronous HTTP request by default. To make an
3177
3177
  asynchronous HTTP request, please pass async_req=True
3178
3178
 
@@ -3215,7 +3215,7 @@ class PersonsApi:
3215
3215
  def upsert_person_access_metadata_with_http_info(self, id_type_scope : Annotated[StrictStr, Field(..., description="Scope of the person identifier.")], id_type_code : Annotated[StrictStr, Field(..., description="Code of the person identifier.")], code : Annotated[StrictStr, Field(..., description="Code of the person under specified identifier type's scope and code.")], metadata_key : Annotated[StrictStr, Field(..., description="Key of the metadata entry to retrieve")], upsert_person_access_metadata_request : Annotated[UpsertPersonAccessMetadataRequest, Field(..., description="The Person Access Metadata entry to upsert")], effective_at : Annotated[Optional[StrictStr], Field( description="The effectiveAt datetime at which to upsert 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
3216
3216
  """[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. # noqa: E501
3217
3217
 
3218
- Update or insert one Person 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 Person 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
3218
+ Update or insert one Person 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 Person 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
3219
3219
  This method makes a synchronous HTTP request by default. To make an
3220
3220
  asynchronous HTTP request, please pass async_req=True
3221
3221