lusid-sdk 2.0.50b0__py3-none-any.whl → 2.0.470__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

Files changed (332) hide show
  1. lusid/__init__.py +1117 -14
  2. lusid/api/__init__.py +69 -0
  3. lusid/api/abor_api.py +513 -179
  4. lusid/api/abor_configuration_api.py +25 -24
  5. lusid/api/allocations_api.py +12 -20
  6. lusid/api/blocks_api.py +6 -6
  7. lusid/api/calendars_api.py +16 -24
  8. lusid/api/chart_of_accounts_api.py +1745 -441
  9. lusid/api/compliance_api.py +71 -62
  10. lusid/api/configuration_recipe_api.py +1198 -56
  11. lusid/api/corporate_action_sources_api.py +8 -8
  12. lusid/api/custom_entities_api.py +6 -6
  13. lusid/api/cut_label_definitions_api.py +9 -17
  14. lusid/api/data_types_api.py +16 -32
  15. lusid/api/executions_api.py +6 -6
  16. lusid/api/funds_api.py +1119 -0
  17. lusid/api/instrument_event_types_api.py +1287 -0
  18. lusid/api/instruments_api.py +12 -20
  19. lusid/api/legacy_compliance_api.py +12 -12
  20. lusid/api/legal_entities_api.py +12 -12
  21. lusid/api/order_graph_api.py +12 -12
  22. lusid/api/order_instructions_api.py +6 -6
  23. lusid/api/order_management_api.py +495 -14
  24. lusid/api/orders_api.py +16 -24
  25. lusid/api/packages_api.py +6 -6
  26. lusid/api/persons_api.py +16 -24
  27. lusid/api/placements_api.py +12 -12
  28. lusid/api/portfolio_groups_api.py +6 -6
  29. lusid/api/portfolios_api.py +23 -39
  30. lusid/api/property_definitions_api.py +205 -0
  31. lusid/api/queryable_keys_api.py +211 -0
  32. lusid/api/quotes_api.py +20 -36
  33. lusid/api/reconciliations_api.py +410 -1978
  34. lusid/api/schemas_api.py +7 -15
  35. lusid/api/scopes_api.py +151 -0
  36. lusid/api/scripted_translation_api.py +30 -28
  37. lusid/api/staging_rule_set_api.py +885 -0
  38. lusid/api/transaction_configuration_api.py +22 -22
  39. lusid/api/transaction_portfolios_api.py +282 -577
  40. lusid/api_client.py +5 -3
  41. lusid/configuration.py +1 -1
  42. lusid/extensions/__init__.py +10 -7
  43. lusid/extensions/api_client.py +3 -1
  44. lusid/extensions/api_client_factory.py +156 -45
  45. lusid/extensions/api_configuration.py +124 -15
  46. lusid/extensions/configuration_loaders.py +2 -4
  47. lusid/extensions/proxy_config.py +8 -5
  48. lusid/extensions/socket_keep_alive.py +14 -15
  49. lusid/extensions/tcp_keep_alive_connector.py +93 -46
  50. lusid/models/__init__.py +1028 -13
  51. lusid/models/abor.py +9 -2
  52. lusid/models/abor_configuration.py +8 -8
  53. lusid/models/abor_configuration_request.py +9 -9
  54. lusid/models/abor_request.py +1 -1
  55. lusid/models/account.py +6 -1
  56. lusid/models/accumulation_event.py +104 -0
  57. lusid/models/address_key_compliance_parameter.py +5 -12
  58. lusid/models/address_key_list_compliance_parameter.py +3 -3
  59. lusid/models/address_key_option_definition.py +3 -1
  60. lusid/models/amortisation_event.py +4 -6
  61. lusid/models/{underlying_leg.py → asset_leg.py} +15 -15
  62. lusid/models/basket.py +3 -3
  63. lusid/models/block_and_order_id_request.py +78 -0
  64. lusid/models/block_and_orders.py +83 -0
  65. lusid/models/block_and_orders_create_request.py +77 -0
  66. lusid/models/block_and_orders_request.py +134 -0
  67. lusid/models/blocked_order_request.py +130 -0
  68. lusid/models/bond.py +13 -6
  69. lusid/models/bond_coupon_event.py +97 -0
  70. lusid/models/bond_default_event.py +8 -18
  71. lusid/models/bond_principal_event.py +97 -0
  72. lusid/models/book_transactions_request.py +97 -0
  73. lusid/models/bool_compliance_parameter.py +3 -3
  74. lusid/models/bool_list_compliance_parameter.py +3 -3
  75. lusid/models/branch_step.py +101 -0
  76. lusid/models/cap_floor.py +3 -3
  77. lusid/models/cash_dividend_event.py +32 -10
  78. lusid/models/cash_election.py +91 -0
  79. lusid/models/cash_flow_event.py +5 -7
  80. lusid/models/cash_perpetual.py +3 -3
  81. lusid/models/cds_flow_conventions.py +1 -1
  82. lusid/models/cds_index.py +4 -4
  83. lusid/models/check_step.py +110 -0
  84. lusid/models/cleardown_module_details.py +95 -0
  85. lusid/models/cleardown_module_request.py +117 -0
  86. lusid/models/cleardown_module_response.py +139 -0
  87. lusid/models/cleardown_module_rule.py +94 -0
  88. lusid/models/{reconciliation_run_break.py → cleardown_module_rules_updated_response.py} +30 -36
  89. lusid/models/close_event.py +3 -3
  90. lusid/models/close_period_diary_entry_request.py +149 -0
  91. lusid/models/complete_portfolio.py +8 -1
  92. lusid/models/complex_bond.py +4 -4
  93. lusid/models/complex_market_data.py +6 -5
  94. lusid/models/compliance_parameter.py +8 -5
  95. lusid/models/compliance_parameter_type.py +3 -0
  96. lusid/models/compliance_rule_breakdown.py +16 -8
  97. lusid/models/compliance_rule_breakdown_request.py +12 -4
  98. lusid/models/compliance_rule_result_v2.py +85 -0
  99. lusid/models/compliance_step.py +99 -0
  100. lusid/models/compliance_step_type.py +42 -0
  101. lusid/models/compliance_summary_rule_result.py +12 -15
  102. lusid/models/compliance_summary_rule_result_request.py +12 -15
  103. lusid/models/compliance_template_variation.py +12 -2
  104. lusid/models/component_transaction.py +92 -0
  105. lusid/models/composite_dispersion.py +30 -5
  106. lusid/models/compounding.py +4 -4
  107. lusid/models/configuration_recipe.py +10 -19
  108. lusid/models/constant_volatility_surface.py +102 -0
  109. lusid/models/contract_for_difference.py +3 -3
  110. lusid/models/create_derived_property_definition_request.py +3 -3
  111. lusid/models/create_derived_transaction_portfolio_request.py +10 -3
  112. lusid/models/create_property_definition_request.py +12 -5
  113. lusid/models/create_staging_rule_set_request.py +91 -0
  114. lusid/models/create_trade_tickets_response.py +87 -0
  115. lusid/models/create_transaction_portfolio_request.py +16 -3
  116. lusid/models/credit_default_swap.py +4 -4
  117. lusid/models/credit_spread_curve_data.py +4 -4
  118. lusid/models/custom_entity_definition.py +8 -2
  119. lusid/models/custom_entity_type.py +8 -2
  120. lusid/models/cut_label_definition.py +7 -1
  121. lusid/models/data_type.py +7 -1
  122. lusid/models/data_type_summary.py +8 -2
  123. lusid/models/date_time_compliance_parameter.py +3 -3
  124. lusid/models/date_time_list_compliance_parameter.py +3 -3
  125. lusid/models/{upsert_reconciliation_run_request.py → day_month.py} +15 -15
  126. lusid/models/decimal_compliance_parameter.py +3 -3
  127. lusid/models/decimal_list_compliance_parameter.py +3 -3
  128. lusid/models/dialect.py +9 -3
  129. lusid/models/diary_entry.py +1 -1
  130. lusid/models/diary_entry_request.py +1 -1
  131. lusid/models/discount_factor_curve_data.py +3 -3
  132. lusid/models/dividend_option_event.py +129 -0
  133. lusid/models/dividend_reinvestment_event.py +124 -0
  134. lusid/models/election_specification.py +73 -0
  135. lusid/models/eligibility_calculation.py +71 -0
  136. lusid/models/empty_model_options.py +3 -3
  137. lusid/models/equity.py +8 -6
  138. lusid/models/equity_curve_by_prices_data.py +3 -3
  139. lusid/models/equity_model_options.py +3 -3
  140. lusid/models/equity_option.py +3 -3
  141. lusid/models/equity_swap.py +4 -4
  142. lusid/models/equity_vol_surface_data.py +3 -3
  143. lusid/models/exchange_traded_option.py +3 -3
  144. lusid/models/exercise_event.py +5 -7
  145. lusid/models/exotic_instrument.py +3 -3
  146. lusid/models/expiry_event.py +91 -0
  147. lusid/models/filter_predicate_compliance_parameter.py +91 -0
  148. lusid/models/filter_step.py +101 -0
  149. lusid/models/fixed_leg.py +3 -3
  150. lusid/models/fixed_schedule.py +4 -9
  151. lusid/models/flexible_loan.py +105 -0
  152. lusid/models/float_schedule.py +20 -12
  153. lusid/models/floating_leg.py +3 -3
  154. lusid/models/flow_convention_name.py +1 -1
  155. lusid/models/flow_conventions.py +1 -1
  156. lusid/models/forward_rate_agreement.py +3 -3
  157. lusid/models/from_recipe.py +81 -0
  158. lusid/models/fund.py +182 -0
  159. lusid/models/fund_properties.py +115 -0
  160. lusid/models/fund_request.py +165 -0
  161. lusid/models/fund_share_class.py +99 -0
  162. lusid/models/funding_leg.py +3 -3
  163. lusid/models/funding_leg_options.py +3 -3
  164. lusid/models/future.py +3 -3
  165. lusid/models/fx_conventions.py +73 -0
  166. lusid/models/fx_forward.py +8 -6
  167. lusid/models/fx_forward_curve_by_quote_reference.py +4 -4
  168. lusid/models/fx_forward_curve_data.py +3 -3
  169. lusid/models/fx_forward_model_options.py +3 -3
  170. lusid/models/fx_forward_pips_curve_data.py +3 -3
  171. lusid/models/fx_forward_settlement_event.py +136 -0
  172. lusid/models/fx_forward_tenor_curve_data.py +4 -4
  173. lusid/models/fx_forward_tenor_pips_curve_data.py +4 -4
  174. lusid/models/fx_linked_notional_schedule.py +108 -0
  175. lusid/models/fx_option.py +3 -3
  176. lusid/models/fx_rate_schedule.py +3 -3
  177. lusid/models/fx_swap.py +4 -4
  178. lusid/models/fx_vol_surface_data.py +3 -3
  179. lusid/models/{reconciliation_run.py → get_recipe_composer_response.py} +15 -15
  180. lusid/models/group_by_selector_compliance_parameter.py +91 -0
  181. lusid/models/group_by_step.py +101 -0
  182. lusid/models/group_filter_predicate_compliance_parameter.py +91 -0
  183. lusid/models/group_filter_step.py +110 -0
  184. lusid/models/group_of_market_data_key_rules.py +79 -0
  185. lusid/models/index_convention.py +1 -1
  186. lusid/models/index_model_options.py +3 -3
  187. lusid/models/inflation_index_conventions.py +2 -2
  188. lusid/models/inflation_leg.py +3 -3
  189. lusid/models/inflation_linked_bond.py +3 -3
  190. lusid/models/inflation_swap.py +4 -4
  191. lusid/models/informational_error_event.py +3 -3
  192. lusid/models/informational_event.py +4 -6
  193. lusid/models/instrument_event.py +13 -5
  194. lusid/models/instrument_event_configuration.py +74 -0
  195. lusid/models/instrument_event_holder.py +12 -3
  196. lusid/models/instrument_event_type.py +8 -0
  197. lusid/models/instrument_leg.py +3 -3
  198. lusid/models/instrument_list_compliance_parameter.py +3 -3
  199. lusid/models/instrument_payment_diary_leg.py +5 -3
  200. lusid/models/instrument_resolution_detail.py +105 -0
  201. lusid/models/instrument_type.py +2 -0
  202. lusid/models/interest_rate_swap.py +4 -4
  203. lusid/models/interest_rate_swaption.py +3 -3
  204. lusid/models/intermediate_compliance_step.py +110 -0
  205. lusid/models/ir_vol_cube_data.py +3 -3
  206. lusid/models/journal_entry_line.py +34 -3
  207. lusid/models/journal_entry_lines_query_parameters.py +1 -1
  208. lusid/models/label_value_set.py +1 -1
  209. lusid/models/leg_definition.py +16 -3
  210. lusid/models/lineage_member.py +87 -0
  211. lusid/models/lock_period_diary_entry_request.py +91 -0
  212. lusid/models/lusid_instrument.py +7 -5
  213. lusid/models/lusid_trade_ticket.py +8 -1
  214. lusid/models/market_context.py +17 -2
  215. lusid/models/market_data_type.py +1 -0
  216. lusid/models/maturity_event.py +91 -0
  217. lusid/models/model_options.py +5 -6
  218. lusid/models/model_options_type.py +0 -1
  219. lusid/models/model_selection.py +3 -3
  220. lusid/models/move_orders_to_different_blocks_request.py +77 -0
  221. lusid/models/moved_order_to_different_block_response.py +85 -0
  222. lusid/models/movement_type.py +2 -0
  223. lusid/models/multi_currency_amounts.py +71 -0
  224. lusid/models/opaque_market_data.py +3 -3
  225. lusid/models/opaque_model_options.py +3 -3
  226. lusid/models/open_event.py +3 -3
  227. lusid/models/optionality_schedule.py +3 -3
  228. lusid/models/order_graph_block.py +4 -2
  229. lusid/models/order_graph_block_order_detail.py +16 -2
  230. lusid/models/output_transaction.py +9 -2
  231. lusid/models/paged_resource_list_of_cleardown_module_response.py +113 -0
  232. lusid/models/{paged_resource_list_of_reconciliation_run_break.py → paged_resource_list_of_cleardown_module_rule.py} +11 -11
  233. lusid/models/{paged_resource_list_of_reconciliation_run.py → paged_resource_list_of_fund.py} +11 -11
  234. lusid/models/paged_resource_list_of_property_definition.py +113 -0
  235. lusid/models/paged_resource_list_of_staging_rule_set.py +113 -0
  236. lusid/models/paged_resource_list_of_transaction_template.py +113 -0
  237. lusid/models/paged_resource_list_of_transaction_template_specification.py +113 -0
  238. lusid/models/participation_request.py +3 -9
  239. lusid/models/performance_returns_metric.py +1 -1
  240. lusid/models/period_diary_entries_reopened_response.py +104 -0
  241. lusid/models/place_blocks_request.py +77 -0
  242. lusid/models/portfolio.py +15 -2
  243. lusid/models/portfolio_details.py +15 -2
  244. lusid/models/portfolio_group_id_compliance_parameter.py +3 -3
  245. lusid/models/portfolio_group_id_list_compliance_parameter.py +3 -3
  246. lusid/models/portfolio_holding.py +27 -2
  247. lusid/models/portfolio_id_compliance_parameter.py +3 -3
  248. lusid/models/portfolio_id_list_compliance_parameter.py +3 -3
  249. lusid/models/posting_module_rule.py +29 -4
  250. lusid/models/pricing_model.py +2 -1
  251. lusid/models/property_definition.py +17 -4
  252. lusid/models/property_definition_search_result.py +3 -3
  253. lusid/models/property_domain.py +3 -0
  254. lusid/models/property_key_compliance_parameter.py +3 -3
  255. lusid/models/property_key_list_compliance_parameter.py +3 -3
  256. lusid/models/queryable_key.py +124 -0
  257. lusid/models/raw_vendor_event.py +5 -7
  258. lusid/models/re_open_period_diary_entry_request.py +84 -0
  259. lusid/models/recipe_block.py +87 -0
  260. lusid/models/recipe_composer.py +100 -0
  261. lusid/models/{reconciliation_break_id.py → recipe_value.py} +22 -23
  262. lusid/models/recombine_step.py +101 -0
  263. lusid/models/reference_instrument.py +3 -3
  264. lusid/models/relative_date_offset.py +71 -0
  265. lusid/models/repo.py +3 -3
  266. lusid/models/reset_event.py +4 -6
  267. lusid/models/resource_list_of_block_and_orders.py +113 -0
  268. lusid/models/resource_list_of_get_recipe_composer_response.py +113 -0
  269. lusid/models/resource_list_of_moved_order_to_different_block_response.py +113 -0
  270. lusid/models/resource_list_of_queryable_key.py +113 -0
  271. lusid/models/schedule.py +6 -5
  272. lusid/models/schedule_type.py +1 -0
  273. lusid/models/script_map_reference.py +94 -0
  274. lusid/models/security_election.py +86 -0
  275. lusid/models/set_share_class_instruments_request.py +79 -0
  276. lusid/models/side_definition.py +1 -8
  277. lusid/models/sides_definition_request.py +1 -8
  278. lusid/models/simple_cash_flow_loan.py +3 -3
  279. lusid/models/simple_instrument.py +3 -3
  280. lusid/models/staging_rule.py +90 -0
  281. lusid/models/staging_rule_approval_criteria.py +81 -0
  282. lusid/models/staging_rule_match_criteria.py +95 -0
  283. lusid/models/staging_rule_set.py +103 -0
  284. lusid/models/step_schedule.py +3 -3
  285. lusid/models/stock_split_event.py +3 -3
  286. lusid/models/string_compliance_parameter.py +3 -3
  287. lusid/models/string_list_compliance_parameter.py +3 -3
  288. lusid/models/template_field.py +77 -0
  289. lusid/models/term_deposit.py +3 -3
  290. lusid/models/total_return_swap.py +16 -16
  291. lusid/models/transaction_configuration_movement_data.py +3 -3
  292. lusid/models/transaction_configuration_movement_data_request.py +3 -3
  293. lusid/models/transaction_currency_and_amount.py +81 -0
  294. lusid/models/transaction_field_map.py +97 -0
  295. lusid/models/transaction_price.py +3 -3
  296. lusid/models/transaction_price_and_type.py +81 -0
  297. lusid/models/transaction_price_type.py +1 -0
  298. lusid/models/transaction_property_map.py +80 -0
  299. lusid/models/transaction_template.py +100 -0
  300. lusid/models/transaction_template_request.py +79 -0
  301. lusid/models/transaction_template_specification.py +99 -0
  302. lusid/models/transaction_type_alias.py +0 -7
  303. lusid/models/transaction_type_calculation.py +1 -1
  304. lusid/models/transition_event.py +3 -3
  305. lusid/models/translation_context.py +75 -0
  306. lusid/models/translation_script.py +9 -3
  307. lusid/models/trial_balance.py +46 -11
  308. lusid/models/trial_balance_query_parameters.py +15 -6
  309. lusid/models/trigger_event.py +3 -3
  310. lusid/models/units_ratio.py +71 -0
  311. lusid/models/update_staging_rule_set_request.py +91 -0
  312. lusid/models/{compliance_run_summary.py → upsert_compliance_run_summary_result.py} +8 -8
  313. lusid/models/upsert_dialect_request.py +79 -0
  314. lusid/models/upsert_instrument_event_request.py +12 -3
  315. lusid/models/upsert_quote_request.py +1 -1
  316. lusid/models/upsert_recipe_composer_request.py +73 -0
  317. lusid/models/upsert_recipe_request.py +3 -9
  318. lusid/models/upsert_translation_script_request.py +75 -0
  319. lusid/models/valuation_schedule.py +10 -3
  320. lusid/models/weighted_instrument.py +13 -2
  321. lusid/models/weighted_instrument_in_line_lookup_identifiers.py +89 -0
  322. lusid/models/yield_curve_data.py +3 -3
  323. lusid/rest.py +1 -1
  324. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/METADATA +245 -48
  325. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/RECORD +326 -235
  326. {lusid_sdk-2.0.50b0.dist-info → lusid_sdk-2.0.470.dist-info}/WHEEL +1 -1
  327. lusid/extensions/api_client_builder.py +0 -138
  328. lusid/models/configuration_recipe_snippet.py +0 -139
  329. lusid/models/je_lines_query_parameters.py +0 -105
  330. lusid/models/look_up_pricing_model_options.py +0 -93
  331. lusid/models/reconciliation_run_id.py +0 -85
  332. lusid/models/upsert_reconciliation_break_request.py +0 -98
@@ -31,6 +31,7 @@ from lusid.models.create_derived_property_definition_request import CreateDerive
31
31
  from lusid.models.create_property_definition_request import CreatePropertyDefinitionRequest
32
32
  from lusid.models.deleted_entity_response import DeletedEntityResponse
33
33
  from lusid.models.model_property import ModelProperty
34
+ from lusid.models.paged_resource_list_of_property_definition import PagedResourceListOfPropertyDefinition
34
35
  from lusid.models.property_definition import PropertyDefinition
35
36
  from lusid.models.resource_list_of_property_definition import ResourceListOfPropertyDefinition
36
37
  from lusid.models.resource_list_of_property_interval import ResourceListOfPropertyInterval
@@ -1305,6 +1306,210 @@ class PropertyDefinitionsApi:
1305
1306
  collection_formats=_collection_formats,
1306
1307
  _request_auth=_params.get('_request_auth'))
1307
1308
 
1309
+ @overload
1310
+ async def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> PagedResourceListOfPropertyDefinition: # noqa: E501
1311
+ ...
1312
+
1313
+ @overload
1314
+ def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfPropertyDefinition: # noqa: E501
1315
+ ...
1316
+
1317
+ @validate_arguments
1318
+ def list_property_definitions(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfPropertyDefinition, Awaitable[PagedResourceListOfPropertyDefinition]]: # noqa: E501
1319
+ """ListPropertyDefinitions: List property definitions # noqa: E501
1320
+
1321
+ List all the property definitions matching particular criteria. # noqa: E501
1322
+ This method makes a synchronous HTTP request by default. To make an
1323
+ asynchronous HTTP request, please pass async_req=True
1324
+
1325
+ >>> thread = api.list_property_definitions(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
1326
+ >>> result = thread.get()
1327
+
1328
+ :param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
1329
+ :type effective_at: str
1330
+ :param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
1331
+ :type as_at: datetime
1332
+ :param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.
1333
+ :type property_keys: List[str]
1334
+ :param page: The pagination token to use to continue listing property definitions; 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.
1335
+ :type page: str
1336
+ :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1337
+ :type limit: int
1338
+ :param filter: Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1339
+ :type filter: str
1340
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
1341
+ :type sort_by: List[str]
1342
+ :param async_req: Whether to execute the request asynchronously.
1343
+ :type async_req: bool, optional
1344
+ :param _request_timeout: timeout setting for this request.
1345
+ If one number provided, it will be total request
1346
+ timeout. It can also be a pair (tuple) of
1347
+ (connection, read) timeouts.
1348
+ :return: Returns the result object.
1349
+ If the method is called asynchronously,
1350
+ returns the request thread.
1351
+ :rtype: PagedResourceListOfPropertyDefinition
1352
+ """
1353
+ kwargs['_return_http_data_only'] = True
1354
+ if '_preload_content' in kwargs:
1355
+ message = "Error! Please call the list_property_definitions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
1356
+ raise ValueError(message)
1357
+ if async_req is not None:
1358
+ kwargs['async_req'] = async_req
1359
+ return self.list_property_definitions_with_http_info(effective_at, as_at, property_keys, page, limit, filter, sort_by, **kwargs) # noqa: E501
1360
+
1361
+ @validate_arguments
1362
+ def list_property_definitions_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing property definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True, le=5000, ge=1)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], Field(description="Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
1363
+ """ListPropertyDefinitions: List property definitions # noqa: E501
1364
+
1365
+ List all the property definitions matching particular criteria. # noqa: E501
1366
+ This method makes a synchronous HTTP request by default. To make an
1367
+ asynchronous HTTP request, please pass async_req=True
1368
+
1369
+ >>> thread = api.list_property_definitions_with_http_info(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
1370
+ >>> result = thread.get()
1371
+
1372
+ :param effective_at: The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
1373
+ :type effective_at: str
1374
+ :param as_at: The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
1375
+ :type as_at: datetime
1376
+ :param property_keys: A list of property keys from the 'Property Definition' domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g \"PropertyDefinition/myScope/someAttributeKey\". Each property must be from the \"PropertyDefinition\" domain.
1377
+ :type property_keys: List[str]
1378
+ :param page: The pagination token to use to continue listing property definitions; 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.
1379
+ :type page: str
1380
+ :param limit: When paginating, limit the results to this number. Defaults to 100 if not specified.
1381
+ :type limit: int
1382
+ :param filter: Expression to filter the results. For example, to filter on the display name, specify \"DisplayName eq 'DisplayName'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
1383
+ :type filter: str
1384
+ :param sort_by: A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\"
1385
+ :type sort_by: List[str]
1386
+ :param async_req: Whether to execute the request asynchronously.
1387
+ :type async_req: bool, optional
1388
+ :param _preload_content: if False, the ApiResponse.data will
1389
+ be set to none and raw_data will store the
1390
+ HTTP response body without reading/decoding.
1391
+ Default is True.
1392
+ :type _preload_content: bool, optional
1393
+ :param _return_http_data_only: response data instead of ApiResponse
1394
+ object with status code, headers, etc
1395
+ :type _return_http_data_only: bool, optional
1396
+ :param _request_timeout: timeout setting for this request. If one
1397
+ number provided, it will be total request
1398
+ timeout. It can also be a pair (tuple) of
1399
+ (connection, read) timeouts.
1400
+ :param _request_auth: set to override the auth_settings for an a single
1401
+ request; this effectively ignores the authentication
1402
+ in the spec for a single request.
1403
+ :type _request_auth: dict, optional
1404
+ :type _content_type: string, optional: force content-type for the request
1405
+ :return: Returns the result object.
1406
+ If the method is called asynchronously,
1407
+ returns the request thread.
1408
+ :rtype: tuple(PagedResourceListOfPropertyDefinition, status_code(int), headers(HTTPHeaderDict))
1409
+ """
1410
+
1411
+ _params = locals()
1412
+
1413
+ _all_params = [
1414
+ 'effective_at',
1415
+ 'as_at',
1416
+ 'property_keys',
1417
+ 'page',
1418
+ 'limit',
1419
+ 'filter',
1420
+ 'sort_by'
1421
+ ]
1422
+ _all_params.extend(
1423
+ [
1424
+ 'async_req',
1425
+ '_return_http_data_only',
1426
+ '_preload_content',
1427
+ '_request_timeout',
1428
+ '_request_auth',
1429
+ '_content_type',
1430
+ '_headers'
1431
+ ]
1432
+ )
1433
+
1434
+ # validate the arguments
1435
+ for _key, _val in _params['kwargs'].items():
1436
+ if _key not in _all_params:
1437
+ raise ApiTypeError(
1438
+ "Got an unexpected keyword argument '%s'"
1439
+ " to method list_property_definitions" % _key
1440
+ )
1441
+ _params[_key] = _val
1442
+ del _params['kwargs']
1443
+
1444
+ _collection_formats = {}
1445
+
1446
+ # process the path parameters
1447
+ _path_params = {}
1448
+
1449
+ # process the query parameters
1450
+ _query_params = []
1451
+ if _params.get('effective_at') is not None: # noqa: E501
1452
+ _query_params.append(('effectiveAt', _params['effective_at']))
1453
+
1454
+ if _params.get('as_at') is not None: # noqa: E501
1455
+ if isinstance(_params['as_at'], datetime):
1456
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
1457
+ else:
1458
+ _query_params.append(('asAt', _params['as_at']))
1459
+
1460
+ if _params.get('property_keys') is not None: # noqa: E501
1461
+ _query_params.append(('propertyKeys', _params['property_keys']))
1462
+ _collection_formats['propertyKeys'] = 'multi'
1463
+
1464
+ if _params.get('page') is not None: # noqa: E501
1465
+ _query_params.append(('page', _params['page']))
1466
+
1467
+ if _params.get('limit') is not None: # noqa: E501
1468
+ _query_params.append(('limit', _params['limit']))
1469
+
1470
+ if _params.get('filter') is not None: # noqa: E501
1471
+ _query_params.append(('filter', _params['filter']))
1472
+
1473
+ if _params.get('sort_by') is not None: # noqa: E501
1474
+ _query_params.append(('sortBy', _params['sort_by']))
1475
+ _collection_formats['sortBy'] = 'multi'
1476
+
1477
+ # process the header parameters
1478
+ _header_params = dict(_params.get('_headers', {}))
1479
+ # process the form parameters
1480
+ _form_params = []
1481
+ _files = {}
1482
+ # process the body parameter
1483
+ _body_params = None
1484
+ # set the HTTP header `Accept`
1485
+ _header_params['Accept'] = self.api_client.select_header_accept(
1486
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
1487
+
1488
+ # authentication setting
1489
+ _auth_settings = ['oauth2'] # noqa: E501
1490
+
1491
+ _response_types_map = {
1492
+ '200': "PagedResourceListOfPropertyDefinition",
1493
+ '400': "LusidValidationProblemDetails",
1494
+ }
1495
+
1496
+ return self.api_client.call_api(
1497
+ '/api/propertydefinitions/$list', 'GET',
1498
+ _path_params,
1499
+ _query_params,
1500
+ _header_params,
1501
+ body=_body_params,
1502
+ post_params=_form_params,
1503
+ files=_files,
1504
+ response_types_map=_response_types_map,
1505
+ auth_settings=_auth_settings,
1506
+ async_req=_params.get('async_req'),
1507
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1508
+ _preload_content=_params.get('_preload_content', True),
1509
+ _request_timeout=_params.get('_request_timeout'),
1510
+ collection_formats=_collection_formats,
1511
+ _request_auth=_params.get('_request_auth'))
1512
+
1308
1513
  @overload
1309
1514
  async def update_derived_property_definition(self, domain : Annotated[StrictStr, Field(..., description="Domain of the property definition")], scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Scope of the property definition")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="Code of the property definition")], update_derived_property_definition_request : Annotated[UpdateDerivedPropertyDefinitionRequest, Field(..., description="Information about the derived property definition being updated")], **kwargs) -> PropertyDefinition: # noqa: E501
1310
1515
  ...
@@ -0,0 +1,211 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ LUSID API
5
+
6
+ FINBOURNE Technology # noqa: E501
7
+
8
+ Contact: info@finbourne.com
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """
13
+
14
+
15
+ import re # noqa: F401
16
+ import io
17
+ import warnings
18
+
19
+ from pydantic import validate_arguments, ValidationError
20
+ from typing import overload, Optional, Union, Awaitable
21
+
22
+ from typing_extensions import Annotated
23
+ from datetime import datetime
24
+
25
+ from pydantic import Field, constr, validator
26
+
27
+ from typing import Optional
28
+
29
+ from lusid.models.resource_list_of_queryable_key import ResourceListOfQueryableKey
30
+
31
+ from lusid.api_client import ApiClient
32
+ from lusid.api_response import ApiResponse
33
+ from lusid.exceptions import ( # noqa: F401
34
+ ApiTypeError,
35
+ ApiValueError
36
+ )
37
+
38
+
39
+ class QueryableKeysApi:
40
+ """NOTE: This class is auto generated by OpenAPI Generator
41
+ Ref: https://openapi-generator.tech
42
+
43
+ Do not edit the class manually.
44
+ """
45
+
46
+ def __init__(self, api_client=None) -> None:
47
+ if api_client is None:
48
+ api_client = ApiClient.get_default()
49
+ self.api_client = api_client
50
+
51
+ @overload
52
+ async def get_all_queryable_keys(self, as_at : Annotated[Optional[datetime], Field(description="For user defined DerivedValuation keys.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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, **kwargs) -> ResourceListOfQueryableKey: # noqa: E501
53
+ ...
54
+
55
+ @overload
56
+ def get_all_queryable_keys(self, as_at : Annotated[Optional[datetime], Field(description="For user defined DerivedValuation keys.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfQueryableKey: # noqa: E501
57
+ ...
58
+
59
+ @validate_arguments
60
+ def get_all_queryable_keys(self, as_at : Annotated[Optional[datetime], Field(description="For user defined DerivedValuation keys.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfQueryableKey, Awaitable[ResourceListOfQueryableKey]]: # noqa: E501
61
+ """[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \"addresses\" that can be queried from all endpoints. # noqa: E501
62
+
63
+ When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, # noqa: E501
64
+ This method makes a synchronous HTTP request by default. To make an
65
+ asynchronous HTTP request, please pass async_req=True
66
+
67
+ >>> thread = api.get_all_queryable_keys(as_at, filter, async_req=True)
68
+ >>> result = thread.get()
69
+
70
+ :param as_at: For user defined DerivedValuation keys.
71
+ :type as_at: datetime
72
+ :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
73
+ :type filter: str
74
+ :param async_req: Whether to execute the request asynchronously.
75
+ :type async_req: bool, optional
76
+ :param _request_timeout: timeout setting for this request.
77
+ If one number provided, it will be total request
78
+ timeout. It can also be a pair (tuple) of
79
+ (connection, read) timeouts.
80
+ :return: Returns the result object.
81
+ If the method is called asynchronously,
82
+ returns the request thread.
83
+ :rtype: ResourceListOfQueryableKey
84
+ """
85
+ kwargs['_return_http_data_only'] = True
86
+ if '_preload_content' in kwargs:
87
+ message = "Error! Please call the get_all_queryable_keys_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
88
+ raise ValueError(message)
89
+ if async_req is not None:
90
+ kwargs['async_req'] = async_req
91
+ return self.get_all_queryable_keys_with_http_info(as_at, filter, **kwargs) # noqa: E501
92
+
93
+ @validate_arguments
94
+ def get_all_queryable_keys_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="For user defined DerivedValuation keys.")] = None, filter : Annotated[Optional[constr(strict=True, max_length=16384, min_length=0)], 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, **kwargs) -> ApiResponse: # noqa: E501
95
+ """[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported \"addresses\" that can be queried from all endpoints. # noqa: E501
96
+
97
+ When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys, # noqa: E501
98
+ This method makes a synchronous HTTP request by default. To make an
99
+ asynchronous HTTP request, please pass async_req=True
100
+
101
+ >>> thread = api.get_all_queryable_keys_with_http_info(as_at, filter, async_req=True)
102
+ >>> result = thread.get()
103
+
104
+ :param as_at: For user defined DerivedValuation keys.
105
+ :type as_at: datetime
106
+ :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
107
+ :type filter: str
108
+ :param async_req: Whether to execute the request asynchronously.
109
+ :type async_req: bool, optional
110
+ :param _preload_content: if False, the ApiResponse.data will
111
+ be set to none and raw_data will store the
112
+ HTTP response body without reading/decoding.
113
+ Default is True.
114
+ :type _preload_content: bool, optional
115
+ :param _return_http_data_only: response data instead of ApiResponse
116
+ object with status code, headers, etc
117
+ :type _return_http_data_only: bool, optional
118
+ :param _request_timeout: timeout setting for this request. If one
119
+ number provided, it will be total request
120
+ timeout. It can also be a pair (tuple) of
121
+ (connection, read) timeouts.
122
+ :param _request_auth: set to override the auth_settings for an a single
123
+ request; this effectively ignores the authentication
124
+ in the spec for a single request.
125
+ :type _request_auth: dict, optional
126
+ :type _content_type: string, optional: force content-type for the request
127
+ :return: Returns the result object.
128
+ If the method is called asynchronously,
129
+ returns the request thread.
130
+ :rtype: tuple(ResourceListOfQueryableKey, status_code(int), headers(HTTPHeaderDict))
131
+ """
132
+
133
+ _params = locals()
134
+
135
+ _all_params = [
136
+ 'as_at',
137
+ 'filter'
138
+ ]
139
+ _all_params.extend(
140
+ [
141
+ 'async_req',
142
+ '_return_http_data_only',
143
+ '_preload_content',
144
+ '_request_timeout',
145
+ '_request_auth',
146
+ '_content_type',
147
+ '_headers'
148
+ ]
149
+ )
150
+
151
+ # validate the arguments
152
+ for _key, _val in _params['kwargs'].items():
153
+ if _key not in _all_params:
154
+ raise ApiTypeError(
155
+ "Got an unexpected keyword argument '%s'"
156
+ " to method get_all_queryable_keys" % _key
157
+ )
158
+ _params[_key] = _val
159
+ del _params['kwargs']
160
+
161
+ _collection_formats = {}
162
+
163
+ # process the path parameters
164
+ _path_params = {}
165
+
166
+ # process the query parameters
167
+ _query_params = []
168
+ if _params.get('as_at') is not None: # noqa: E501
169
+ if isinstance(_params['as_at'], datetime):
170
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
171
+ else:
172
+ _query_params.append(('asAt', _params['as_at']))
173
+
174
+ if _params.get('filter') is not None: # noqa: E501
175
+ _query_params.append(('filter', _params['filter']))
176
+
177
+ # process the header parameters
178
+ _header_params = dict(_params.get('_headers', {}))
179
+ # process the form parameters
180
+ _form_params = []
181
+ _files = {}
182
+ # process the body parameter
183
+ _body_params = None
184
+ # set the HTTP header `Accept`
185
+ _header_params['Accept'] = self.api_client.select_header_accept(
186
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
187
+
188
+ # authentication setting
189
+ _auth_settings = ['oauth2'] # noqa: E501
190
+
191
+ _response_types_map = {
192
+ '200': "ResourceListOfQueryableKey",
193
+ '400': "LusidValidationProblemDetails",
194
+ }
195
+
196
+ return self.api_client.call_api(
197
+ '/api/queryablekeys', 'GET',
198
+ _path_params,
199
+ _query_params,
200
+ _header_params,
201
+ body=_body_params,
202
+ post_params=_form_params,
203
+ files=_files,
204
+ response_types_map=_response_types_map,
205
+ auth_settings=_auth_settings,
206
+ async_req=_params.get('async_req'),
207
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
208
+ _preload_content=_params.get('_preload_content', True),
209
+ _request_timeout=_params.get('_request_timeout'),
210
+ collection_formats=_collection_formats,
211
+ _request_auth=_params.get('_request_auth'))