lusid-sdk 2.1.405__py3-none-any.whl → 2.1.537__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 (294) hide show
  1. lusid/__init__.py +142 -8
  2. lusid/api/__init__.py +2 -2
  3. lusid/api/abor_api.py +126 -133
  4. lusid/api/abor_configuration_api.py +46 -45
  5. lusid/api/address_key_definition_api.py +28 -27
  6. lusid/api/aggregation_api.py +37 -36
  7. lusid/api/allocations_api.py +39 -38
  8. lusid/api/amortisation_rule_sets_api.py +55 -54
  9. lusid/api/application_metadata_api.py +28 -27
  10. lusid/api/blocks_api.py +37 -36
  11. lusid/api/calendars_api.py +469 -111
  12. lusid/api/chart_of_accounts_api.py +454 -279
  13. lusid/api/complex_market_data_api.py +37 -36
  14. lusid/api/compliance_api.py +136 -135
  15. lusid/api/configuration_recipe_api.py +100 -99
  16. lusid/api/conventions_api.py +109 -108
  17. lusid/api/corporate_action_sources_api.py +82 -81
  18. lusid/api/counterparties_api.py +73 -72
  19. lusid/api/custom_entities_api.py +102 -101
  20. lusid/api/custom_entity_definitions_api.py +37 -36
  21. lusid/api/custom_entity_types_api.py +37 -36
  22. lusid/api/cut_label_definitions_api.py +46 -45
  23. lusid/api/data_types_api.py +248 -72
  24. lusid/api/derived_transaction_portfolios_api.py +19 -18
  25. lusid/api/entities_api.py +431 -46
  26. lusid/api/executions_api.py +37 -36
  27. lusid/api/fee_types_api.py +55 -54
  28. lusid/api/{fund_configurations_api.py → fund_configuration_api.py} +222 -46
  29. lusid/api/funds_api.py +337 -162
  30. lusid/api/group_reconciliations_api.py +2182 -63
  31. lusid/api/instrument_event_types_api.py +64 -63
  32. lusid/api/instrument_events_api.py +46 -45
  33. lusid/api/instruments_api.py +374 -186
  34. lusid/api/legacy_compliance_api.py +73 -72
  35. lusid/api/legal_entities_api.py +167 -166
  36. lusid/api/order_graph_api.py +32 -31
  37. lusid/api/order_instructions_api.py +37 -36
  38. lusid/api/order_management_api.py +251 -90
  39. lusid/api/orders_api.py +37 -36
  40. lusid/api/packages_api.py +37 -36
  41. lusid/api/participations_api.py +37 -36
  42. lusid/api/persons_api.py +163 -162
  43. lusid/api/placements_api.py +37 -36
  44. lusid/api/portfolio_groups_api.py +235 -234
  45. lusid/api/portfolios_api.py +307 -309
  46. lusid/api/property_definitions_api.py +100 -99
  47. lusid/api/queryable_keys_api.py +10 -9
  48. lusid/api/quotes_api.py +82 -81
  49. lusid/api/reconciliations_api.py +136 -135
  50. lusid/api/reference_lists_api.py +39 -38
  51. lusid/api/reference_portfolio_api.py +213 -36
  52. lusid/api/relation_definitions_api.py +28 -27
  53. lusid/api/relations_api.py +19 -18
  54. lusid/api/relationship_definitions_api.py +46 -45
  55. lusid/api/relationships_api.py +19 -18
  56. lusid/api/schemas_api.py +37 -36
  57. lusid/api/scopes_api.py +19 -18
  58. lusid/api/scripted_translation_api.py +73 -72
  59. lusid/api/search_api.py +37 -36
  60. lusid/api/sequences_api.py +37 -36
  61. lusid/api/staged_modifications_api.py +37 -36
  62. lusid/api/staging_rule_set_api.py +46 -45
  63. lusid/api/structured_result_data_api.py +82 -81
  64. lusid/api/system_configuration_api.py +64 -63
  65. lusid/api/tax_rule_sets_api.py +46 -45
  66. lusid/api/transaction_configuration_api.py +100 -99
  67. lusid/api/transaction_fees_api.py +46 -45
  68. lusid/api/transaction_portfolios_api.py +771 -328
  69. lusid/api/translation_api.py +19 -18
  70. lusid/api/workspace_api.py +181 -180
  71. lusid/api_client.py +26 -17
  72. lusid/configuration.py +87 -2
  73. lusid/extensions/api_client.py +25 -17
  74. lusid/extensions/api_client_factory.py +14 -5
  75. lusid/extensions/api_configuration.py +50 -1
  76. lusid/extensions/configuration_loaders.py +39 -11
  77. lusid/extensions/configuration_options.py +67 -0
  78. lusid/extensions/rest.py +78 -26
  79. lusid/extensions/retry.py +109 -37
  80. lusid/models/__init__.py +140 -6
  81. lusid/models/access_metadata_value.py +1 -1
  82. lusid/models/accounting_method.py +7 -0
  83. lusid/models/accumulation_event.py +3 -3
  84. lusid/models/address_key_list.py +3 -3
  85. lusid/models/amortisation_event.py +3 -3
  86. lusid/models/amount.py +69 -0
  87. lusid/models/applicable_instrument_event.py +7 -2
  88. lusid/models/asset_leg.py +1 -1
  89. lusid/models/basket.py +3 -3
  90. lusid/models/batch_update_user_review_for_comparison_result_request.py +81 -0
  91. lusid/models/batch_update_user_review_for_comparison_result_response.py +146 -0
  92. lusid/models/batch_upsert_dates_for_calendar_response.py +146 -0
  93. lusid/models/batch_upsert_portfolio_access_metadata_request.py +27 -17
  94. lusid/models/batch_upsert_portfolio_access_metadata_response.py +56 -16
  95. lusid/models/{metadata_key_value.py → batch_upsert_portfolio_access_metadata_response_item.py} +15 -9
  96. lusid/models/bond.py +3 -3
  97. lusid/models/bond_coupon_event.py +10 -5
  98. lusid/models/bond_default_event.py +3 -3
  99. lusid/models/bond_principal_event.py +10 -5
  100. lusid/models/bonus_issue_event.py +166 -0
  101. lusid/models/{component_rule.py → break_code_source.py} +17 -21
  102. lusid/models/call_on_intermediate_securities_event.py +139 -0
  103. lusid/models/cancel_order_and_move_remaining_result.py +84 -0
  104. lusid/models/cancel_orders_and_move_remaining_request.py +83 -0
  105. lusid/models/cancel_orders_and_move_remaining_response.py +153 -0
  106. lusid/models/cap_floor.py +3 -3
  107. lusid/models/capital_distribution_event.py +3 -3
  108. lusid/models/cash.py +3 -3
  109. lusid/models/cash_dividend_event.py +3 -3
  110. lusid/models/cash_flow_event.py +3 -3
  111. lusid/models/cash_perpetual.py +3 -3
  112. lusid/models/cds_credit_event.py +6 -6
  113. lusid/models/cds_index.py +3 -3
  114. lusid/models/cdx_credit_event.py +6 -6
  115. lusid/models/change_interval.py +123 -0
  116. lusid/models/change_interval_with_order_management_detail.py +3 -3
  117. lusid/models/close_event.py +3 -3
  118. lusid/models/comparison_attribute_value_pair.py +71 -0
  119. lusid/models/complex_bond.py +3 -3
  120. lusid/models/component_transaction.py +10 -3
  121. lusid/models/contract_for_difference.py +3 -3
  122. lusid/models/create_derived_transaction_portfolio_request.py +3 -3
  123. lusid/models/create_group_reconciliation_definition_request.py +113 -0
  124. lusid/models/create_staging_rule_set_request.py +1 -6
  125. lusid/models/create_transaction_portfolio_request.py +3 -3
  126. lusid/models/credit_default_swap.py +3 -3
  127. lusid/models/credit_premium_cash_flow_event.py +3 -3
  128. lusid/models/custodian_account_request.py +1 -1
  129. lusid/models/custom_entity_entity.py +146 -0
  130. lusid/models/custom_entity_response.py +7 -1
  131. lusid/models/decimal_list.py +3 -3
  132. lusid/models/delete_instrument_properties_response.py +7 -1
  133. lusid/models/delete_instrument_response.py +7 -1
  134. lusid/models/delete_instruments_response.py +22 -1
  135. lusid/models/deleted_entity_response.py +7 -1
  136. lusid/models/diary_entry_request.py +10 -1
  137. lusid/models/dividend_option_event.py +3 -3
  138. lusid/models/dividend_reinvestment_event.py +9 -4
  139. lusid/models/effective_range.py +71 -0
  140. lusid/models/equity.py +3 -3
  141. lusid/models/equity_option.py +22 -7
  142. lusid/models/equity_swap.py +3 -3
  143. lusid/models/exchange_traded_option.py +3 -3
  144. lusid/models/exchange_traded_option_contract_details.py +1 -1
  145. lusid/models/exercise_event.py +3 -3
  146. lusid/models/exotic_instrument.py +3 -3
  147. lusid/models/expiry_event.py +3 -3
  148. lusid/models/fee.py +17 -10
  149. lusid/models/fee_request.py +20 -13
  150. lusid/models/fee_type.py +4 -4
  151. lusid/models/fee_type_request.py +3 -3
  152. lusid/models/fixed_leg.py +3 -3
  153. lusid/models/fixed_schedule.py +3 -3
  154. lusid/models/flexible_loan.py +3 -3
  155. lusid/models/float_schedule.py +4 -4
  156. lusid/models/floating_leg.py +3 -3
  157. lusid/models/flow_conventions.py +7 -1
  158. lusid/models/forward_rate_agreement.py +3 -3
  159. lusid/models/fund_configuration.py +44 -17
  160. lusid/models/fund_configuration_request.py +31 -19
  161. lusid/models/fund_id_list.py +99 -0
  162. lusid/models/fund_share_class.py +23 -8
  163. lusid/models/funding_leg.py +3 -3
  164. lusid/models/future.py +3 -3
  165. lusid/models/future_expiry_event.py +3 -3
  166. lusid/models/fx_forward.py +3 -3
  167. lusid/models/fx_forward_settlement_event.py +3 -3
  168. lusid/models/fx_option.py +3 -3
  169. lusid/models/fx_swap.py +3 -3
  170. lusid/models/group_reconciliation_aggregate_attribute_rule.py +2 -2
  171. lusid/models/group_reconciliation_aggregate_attribute_values.py +86 -0
  172. lusid/models/group_reconciliation_aggregate_comparison_rule_operand.py +1 -1
  173. lusid/models/group_reconciliation_comparison_result.py +148 -0
  174. lusid/models/group_reconciliation_core_attribute_values.py +86 -0
  175. lusid/models/group_reconciliation_core_comparison_rule_operand.py +1 -1
  176. lusid/models/group_reconciliation_date_pair.py +81 -0
  177. lusid/models/group_reconciliation_dates.py +78 -0
  178. lusid/models/group_reconciliation_definition.py +136 -0
  179. lusid/models/group_reconciliation_definition_comparison_ruleset_ids.py +83 -0
  180. lusid/models/group_reconciliation_definition_currencies.py +71 -0
  181. lusid/models/group_reconciliation_definition_portfolio_entity_ids.py +86 -0
  182. lusid/models/group_reconciliation_definition_recipe_ids.py +78 -0
  183. lusid/models/group_reconciliation_instance_id.py +71 -0
  184. lusid/models/group_reconciliation_result_statuses.py +89 -0
  185. lusid/models/group_reconciliation_result_types.py +96 -0
  186. lusid/models/group_reconciliation_review_statuses.py +96 -0
  187. lusid/models/group_reconciliation_run_details.py +76 -0
  188. lusid/models/group_reconciliation_run_request.py +75 -0
  189. lusid/models/{metadata_key_value_response.py → group_reconciliation_run_response.py} +20 -29
  190. lusid/models/group_reconciliation_summary.py +121 -0
  191. lusid/models/group_reconciliation_user_review.py +112 -0
  192. lusid/models/group_reconciliation_user_review_add.py +88 -0
  193. lusid/models/group_reconciliation_user_review_break_code.py +80 -0
  194. lusid/models/group_reconciliation_user_review_comment.py +80 -0
  195. lusid/models/group_reconciliation_user_review_match_key.py +80 -0
  196. lusid/models/group_reconciliation_user_review_remove.py +88 -0
  197. lusid/models/holding_contributor.py +11 -4
  198. lusid/models/holding_ids_request.py +69 -0
  199. lusid/models/inflation_leg.py +3 -3
  200. lusid/models/inflation_linked_bond.py +3 -3
  201. lusid/models/inflation_swap.py +3 -3
  202. lusid/models/informational_error_event.py +3 -3
  203. lusid/models/informational_event.py +3 -3
  204. lusid/models/instrument.py +7 -1
  205. lusid/models/instrument_definition.py +8 -2
  206. lusid/models/instrument_event.py +17 -5
  207. lusid/models/instrument_event_holder.py +9 -1
  208. lusid/models/instrument_event_type.py +12 -0
  209. lusid/models/instrument_leg.py +3 -3
  210. lusid/models/instrument_list.py +3 -3
  211. lusid/models/instrument_type.py +2 -0
  212. lusid/models/interest_rate_swap.py +3 -3
  213. lusid/models/interest_rate_swaption.py +3 -3
  214. lusid/models/intermediate_securities_distribution_event.py +140 -0
  215. lusid/models/lapse_election.py +73 -0
  216. lusid/models/loan_facility.py +97 -0
  217. lusid/models/lusid_instrument.py +7 -5
  218. lusid/models/market_data_key_rule.py +5 -3
  219. lusid/models/market_data_specific_rule.py +5 -3
  220. lusid/models/mastered_instrument.py +139 -0
  221. lusid/models/maturity_event.py +3 -3
  222. lusid/models/mbs_coupon_event.py +102 -0
  223. lusid/models/mbs_interest_deferral_event.py +102 -0
  224. lusid/models/mbs_interest_shortfall_event.py +102 -0
  225. lusid/models/mbs_principal_event.py +102 -0
  226. lusid/models/mbs_principal_write_off_event.py +102 -0
  227. lusid/models/merger_event.py +22 -22
  228. lusid/models/new_instrument.py +1 -1
  229. lusid/models/open_event.py +3 -3
  230. lusid/models/option_exercise_cash_event.py +144 -0
  231. lusid/models/option_exercise_election.py +73 -0
  232. lusid/models/option_exercise_physical_event.py +149 -0
  233. lusid/models/output_transaction.py +9 -2
  234. lusid/models/paged_resource_list_of_group_reconciliation_comparison_result.py +113 -0
  235. lusid/models/paged_resource_list_of_group_reconciliation_comparison_ruleset.py +113 -0
  236. lusid/models/paged_resource_list_of_group_reconciliation_definition.py +113 -0
  237. lusid/models/portfolio.py +3 -3
  238. lusid/models/portfolio_details.py +3 -3
  239. lusid/models/portfolio_group_id_list.py +3 -3
  240. lusid/models/portfolio_id_list.py +3 -3
  241. lusid/models/portfolio_without_href.py +3 -3
  242. lusid/models/pricing_options.py +8 -2
  243. lusid/models/property_list.py +3 -3
  244. lusid/models/protection_payout_cash_flow_event.py +102 -0
  245. lusid/models/raw_vendor_event.py +3 -3
  246. lusid/models/reference_instrument.py +3 -3
  247. lusid/models/reference_list.py +6 -5
  248. lusid/models/reference_list_type.py +1 -0
  249. lusid/models/repo.py +3 -3
  250. lusid/models/reset_event.py +3 -3
  251. lusid/models/resource_list_of_change_interval.py +113 -0
  252. lusid/models/resource_list_of_output_transaction.py +113 -0
  253. lusid/models/return_zero_pv_options.py +69 -0
  254. lusid/models/reverse_stock_split_event.py +21 -7
  255. lusid/models/scrip_dividend_event.py +3 -3
  256. lusid/models/settlement_cycle.py +79 -0
  257. lusid/models/share_class_dealing_breakdown.py +3 -2
  258. lusid/models/share_class_details.py +18 -1
  259. lusid/models/simple_cash_flow_loan.py +3 -3
  260. lusid/models/simple_instrument.py +3 -3
  261. lusid/models/simple_rounding_convention.py +76 -0
  262. lusid/models/spin_off_event.py +3 -3
  263. lusid/models/staged_modification_effective_range.py +2 -2
  264. lusid/models/stock_dividend_event.py +20 -6
  265. lusid/models/stock_split_event.py +3 -3
  266. lusid/models/string_list.py +3 -3
  267. lusid/models/swap_cash_flow_event.py +3 -3
  268. lusid/models/swap_principal_event.py +3 -3
  269. lusid/models/target_tax_lot.py +23 -2
  270. lusid/models/target_tax_lot_request.py +23 -2
  271. lusid/models/tender_event.py +172 -0
  272. lusid/models/term_deposit.py +3 -3
  273. lusid/models/total_return_swap.py +4 -4
  274. lusid/models/transaction.py +9 -2
  275. lusid/models/transaction_date_windows.py +85 -0
  276. lusid/models/transaction_price.py +3 -3
  277. lusid/models/transaction_price_type.py +2 -0
  278. lusid/models/transaction_request.py +9 -2
  279. lusid/models/transition_event.py +3 -3
  280. lusid/models/trigger_event.py +3 -3
  281. lusid/models/update_fee_type_request.py +4 -4
  282. lusid/models/update_group_reconciliation_comparison_ruleset_request.py +91 -0
  283. lusid/models/update_group_reconciliation_definition_request.py +107 -0
  284. lusid/models/update_reference_data_request.py +87 -0
  285. lusid/models/update_staging_rule_set_request.py +1 -6
  286. lusid/models/upsert_custom_entities_response.py +20 -1
  287. lusid/models/upsert_reference_portfolio_constituent_properties_request.py +84 -0
  288. lusid/models/upsert_reference_portfolio_constituent_properties_response.py +115 -0
  289. lusid/models/valuation_point_data_query_parameters.py +3 -3
  290. lusid/models/valuation_point_data_response.py +8 -13
  291. lusid/rest.py +70 -20
  292. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/METADATA +118 -26
  293. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/RECORD +294 -226
  294. {lusid_sdk-2.1.405.dist-info → lusid_sdk-2.1.537.dist-info}/WHEEL +0 -0
lusid/api/entities_api.py CHANGED
@@ -22,15 +22,17 @@ from typing import overload, Optional, Union, Awaitable
22
22
  from typing_extensions import Annotated
23
23
  from datetime import datetime
24
24
 
25
- from pydantic.v1 import Field, StrictStr, conlist, constr, validator
25
+ from pydantic.v1 import Field, StrictStr, conint, conlist, constr, validator
26
26
 
27
27
  from typing import Optional
28
28
 
29
+ from lusid.models.custom_entity_entity import CustomEntityEntity
29
30
  from lusid.models.data_type_entity import DataTypeEntity
30
31
  from lusid.models.instrument_entity import InstrumentEntity
31
32
  from lusid.models.portfolio_entity import PortfolioEntity
32
33
  from lusid.models.property_definition_entity import PropertyDefinitionEntity
33
34
  from lusid.models.resource_list_of_change import ResourceListOfChange
35
+ from lusid.models.resource_list_of_change_interval import ResourceListOfChangeInterval
34
36
 
35
37
  from lusid.api_client import ApiClient
36
38
  from lusid.api_response import ApiResponse
@@ -38,6 +40,7 @@ from lusid.exceptions import ( # noqa: F401
38
40
  ApiTypeError,
39
41
  ApiValueError
40
42
  )
43
+ from lusid.extensions.configuration_options import ConfigurationOptions
41
44
 
42
45
 
43
46
  class EntitiesApi:
@@ -52,6 +55,185 @@ class EntitiesApi:
52
55
  api_client = ApiClient.get_default()
53
56
  self.api_client = api_client
54
57
 
58
+ @overload
59
+ async def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> CustomEntityEntity: # noqa: E501
60
+ ...
61
+
62
+ @overload
63
+ def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=True, **kwargs) -> CustomEntityEntity: # noqa: E501
64
+ ...
65
+
66
+ @validate_arguments
67
+ def get_custom_entity_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[CustomEntityEntity, Awaitable[CustomEntityEntity]]: # noqa: E501
68
+ """[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
69
+
70
+ Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. # noqa: E501
71
+ This method makes a synchronous HTTP request by default. To make an
72
+ asynchronous HTTP request, please pass async_req=True
73
+
74
+ >>> thread = api.get_custom_entity_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True)
75
+ >>> result = thread.get()
76
+
77
+ :param entity_unique_id: The universally unique identifier of the Custom Entity. (required)
78
+ :type entity_unique_id: str
79
+ :param effective_at: The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified.
80
+ :type effective_at: str
81
+ :param as_at: The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.
82
+ :type as_at: datetime
83
+ :param previews: The ids of the staged modifications to be previewed in the response.
84
+ :type previews: List[str]
85
+ :param async_req: Whether to execute the request asynchronously.
86
+ :type async_req: bool, optional
87
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
88
+ :param opts: Configuration options for this request
89
+ :type opts: ConfigurationOptions, optional
90
+ :return: Returns the result object.
91
+ If the method is called asynchronously,
92
+ returns the request thread.
93
+ :rtype: CustomEntityEntity
94
+ """
95
+ kwargs['_return_http_data_only'] = True
96
+ if '_preload_content' in kwargs:
97
+ message = "Error! Please call the get_custom_entity_by_entity_unique_id_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
98
+ raise ValueError(message)
99
+ if async_req is not None:
100
+ kwargs['async_req'] = async_req
101
+ return self.get_custom_entity_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
102
+
103
+ @validate_arguments
104
+ def get_custom_entity_by_entity_unique_id_with_http_info(self, entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the Custom Entity.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Custom Entity. 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 Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> ApiResponse: # noqa: E501
105
+ """[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
106
+
107
+ Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to deletion. # noqa: E501
108
+ This method makes a synchronous HTTP request by default. To make an
109
+ asynchronous HTTP request, please pass async_req=True
110
+
111
+ >>> thread = api.get_custom_entity_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True)
112
+ >>> result = thread.get()
113
+
114
+ :param entity_unique_id: The universally unique identifier of the Custom Entity. (required)
115
+ :type entity_unique_id: str
116
+ :param effective_at: The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified.
117
+ :type effective_at: str
118
+ :param as_at: The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.
119
+ :type as_at: datetime
120
+ :param previews: The ids of the staged modifications to be previewed in the response.
121
+ :type previews: List[str]
122
+ :param async_req: Whether to execute the request asynchronously.
123
+ :type async_req: bool, optional
124
+ :param _preload_content: if False, the ApiResponse.data will
125
+ be set to none and raw_data will store the
126
+ HTTP response body without reading/decoding.
127
+ Default is True.
128
+ :type _preload_content: bool, optional
129
+ :param _return_http_data_only: response data instead of ApiResponse
130
+ object with status code, headers, etc
131
+ :type _return_http_data_only: bool, optional
132
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
133
+ :param opts: Configuration options for this request
134
+ :type opts: ConfigurationOptions, optional
135
+ :param _request_auth: set to override the auth_settings for an a single
136
+ request; this effectively ignores the authentication
137
+ in the spec for a single request.
138
+ :type _request_auth: dict, optional
139
+ :type _content_type: string, optional: force content-type for the request
140
+ :return: Returns the result object.
141
+ If the method is called asynchronously,
142
+ returns the request thread.
143
+ :rtype: tuple(CustomEntityEntity, status_code(int), headers(HTTPHeaderDict))
144
+ """
145
+
146
+ _params = locals()
147
+
148
+ _all_params = [
149
+ 'entity_unique_id',
150
+ 'effective_at',
151
+ 'as_at',
152
+ 'previews'
153
+ ]
154
+ _all_params.extend(
155
+ [
156
+ 'async_req',
157
+ '_return_http_data_only',
158
+ '_preload_content',
159
+ '_request_timeout',
160
+ '_request_auth',
161
+ '_content_type',
162
+ '_headers',
163
+ 'opts'
164
+ ]
165
+ )
166
+
167
+ # validate the arguments
168
+ for _key, _val in _params['kwargs'].items():
169
+ if _key not in _all_params:
170
+ raise ApiTypeError(
171
+ "Got an unexpected keyword argument '%s'"
172
+ " to method get_custom_entity_by_entity_unique_id" % _key
173
+ )
174
+ _params[_key] = _val
175
+ del _params['kwargs']
176
+
177
+ _collection_formats = {}
178
+
179
+ # process the path parameters
180
+ _path_params = {}
181
+ if _params['entity_unique_id']:
182
+ _path_params['entityUniqueId'] = _params['entity_unique_id']
183
+
184
+
185
+ # process the query parameters
186
+ _query_params = []
187
+ if _params.get('effective_at') is not None: # noqa: E501
188
+ _query_params.append(('effectiveAt', _params['effective_at']))
189
+
190
+ if _params.get('as_at') is not None: # noqa: E501
191
+ if isinstance(_params['as_at'], datetime):
192
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
193
+ else:
194
+ _query_params.append(('asAt', _params['as_at']))
195
+
196
+ if _params.get('previews') is not None: # noqa: E501
197
+ _query_params.append(('previews', _params['previews']))
198
+ _collection_formats['previews'] = 'multi'
199
+
200
+ # process the header parameters
201
+ _header_params = dict(_params.get('_headers', {}))
202
+ # process the form parameters
203
+ _form_params = []
204
+ _files = {}
205
+ # process the body parameter
206
+ _body_params = None
207
+ # set the HTTP header `Accept`
208
+ _header_params['Accept'] = self.api_client.select_header_accept(
209
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
210
+
211
+ # authentication setting
212
+ _auth_settings = ['oauth2'] # noqa: E501
213
+
214
+ _response_types_map = {
215
+ '200': "CustomEntityEntity",
216
+ '400': "LusidValidationProblemDetails",
217
+ }
218
+
219
+ return self.api_client.call_api(
220
+ '/api/entities/customentities/{entityUniqueId}', 'GET',
221
+ _path_params,
222
+ _query_params,
223
+ _header_params,
224
+ body=_body_params,
225
+ post_params=_form_params,
226
+ files=_files,
227
+ response_types_map=_response_types_map,
228
+ auth_settings=_auth_settings,
229
+ async_req=_params.get('async_req'),
230
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
231
+ _preload_content=_params.get('_preload_content', True),
232
+ _request_timeout=_params.get('_request_timeout'),
233
+ opts=_params.get('opts'),
234
+ collection_formats=_collection_formats,
235
+ _request_auth=_params.get('_request_auth'))
236
+
55
237
  @overload
56
238
  async def get_data_type_by_entity_unique_id(self, entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the DataType definition.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.")] = None, previews : Annotated[Optional[conlist(StrictStr)], Field(description="The ids of the staged modifications to be previewed in the response.")] = None, **kwargs) -> DataTypeEntity: # noqa: E501
57
239
  ...
@@ -79,10 +261,9 @@ class EntitiesApi:
79
261
  :type previews: List[str]
80
262
  :param async_req: Whether to execute the request asynchronously.
81
263
  :type async_req: bool, optional
82
- :param _request_timeout: timeout setting for this request.
83
- If one number provided, it will be total request
84
- timeout. It can also be a pair (tuple) of
85
- (connection, read) timeouts.
264
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
265
+ :param opts: Configuration options for this request
266
+ :type opts: ConfigurationOptions, optional
86
267
  :return: Returns the result object.
87
268
  If the method is called asynchronously,
88
269
  returns the request thread.
@@ -123,10 +304,9 @@ class EntitiesApi:
123
304
  :param _return_http_data_only: response data instead of ApiResponse
124
305
  object with status code, headers, etc
125
306
  :type _return_http_data_only: bool, optional
126
- :param _request_timeout: timeout setting for this request. If one
127
- number provided, it will be total request
128
- timeout. It can also be a pair (tuple) of
129
- (connection, read) timeouts.
307
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
308
+ :param opts: Configuration options for this request
309
+ :type opts: ConfigurationOptions, optional
130
310
  :param _request_auth: set to override the auth_settings for an a single
131
311
  request; this effectively ignores the authentication
132
312
  in the spec for a single request.
@@ -153,7 +333,8 @@ class EntitiesApi:
153
333
  '_request_timeout',
154
334
  '_request_auth',
155
335
  '_content_type',
156
- '_headers'
336
+ '_headers',
337
+ 'opts'
157
338
  ]
158
339
  )
159
340
 
@@ -220,6 +401,210 @@ class EntitiesApi:
220
401
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
221
402
  _preload_content=_params.get('_preload_content', True),
222
403
  _request_timeout=_params.get('_request_timeout'),
404
+ opts=_params.get('opts'),
405
+ collection_formats=_collection_formats,
406
+ _request_auth=_params.get('_request_auth'))
407
+
408
+ @overload
409
+ async def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy 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 number of returned results to this many. 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ResourceListOfChangeInterval: # noqa: E501
410
+ ...
411
+
412
+ @overload
413
+ def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy 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 number of returned results to this many. 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfChangeInterval: # noqa: E501
414
+ ...
415
+
416
+ @validate_arguments
417
+ def get_entity_history(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy 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 number of returned results to this many. 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfChangeInterval, Awaitable[ResourceListOfChangeInterval]]: # noqa: E501
418
+ """[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
419
+
420
+ Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
421
+ This method makes a synchronous HTTP request by default. To make an
422
+ asynchronous HTTP request, please pass async_req=True
423
+
424
+ >>> thread = api.get_entity_history(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, async_req=True)
425
+ >>> result = thread.get()
426
+
427
+ :param entity_type: The type of the entity to list the change history for. (required)
428
+ :type entity_type: str
429
+ :param entity_unique_id: The universally unique identifier of the entity. (required)
430
+ :type entity_unique_id: str
431
+ :param as_at: The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
432
+ :type as_at: datetime
433
+ :param page: The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.
434
+ :type page: str
435
+ :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
436
+ :type limit: int
437
+ :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
438
+ :type filter: str
439
+ :param sort_by: A list of field names suffixed by \" ASC\" or \" DESC\"
440
+ :type sort_by: List[str]
441
+ :param async_req: Whether to execute the request asynchronously.
442
+ :type async_req: bool, optional
443
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
444
+ :param opts: Configuration options for this request
445
+ :type opts: ConfigurationOptions, optional
446
+ :return: Returns the result object.
447
+ If the method is called asynchronously,
448
+ returns the request thread.
449
+ :rtype: ResourceListOfChangeInterval
450
+ """
451
+ kwargs['_return_http_data_only'] = True
452
+ if '_preload_content' in kwargs:
453
+ message = "Error! Please call the get_entity_history_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
454
+ raise ValueError(message)
455
+ if async_req is not None:
456
+ kwargs['async_req'] = async_req
457
+ return self.get_entity_history_with_http_info(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
458
+
459
+ @validate_arguments
460
+ def get_entity_history_with_http_info(self, entity_type : Annotated[constr(strict=True, max_length=256, min_length=1), Field(..., description="The type of the entity to list the change history for.")], entity_unique_id : Annotated[constr(strict=True, max_length=40, min_length=30), Field(..., description="The universally unique identifier of the entity.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.")] = None, page : Annotated[Optional[constr(strict=True, max_length=500, min_length=1)], Field(description="The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy 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 number of returned results to this many. 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 result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
461
+ """[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
462
+
463
+ Retrieve a page of an entity's change history up to a particular point in AsAt time. # noqa: E501
464
+ This method makes a synchronous HTTP request by default. To make an
465
+ asynchronous HTTP request, please pass async_req=True
466
+
467
+ >>> thread = api.get_entity_history_with_http_info(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, async_req=True)
468
+ >>> result = thread.get()
469
+
470
+ :param entity_type: The type of the entity to list the change history for. (required)
471
+ :type entity_type: str
472
+ :param entity_unique_id: The universally unique identifier of the entity. (required)
473
+ :type entity_unique_id: str
474
+ :param as_at: The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
475
+ :type as_at: datetime
476
+ :param page: The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt fields must not have changed since the original request.
477
+ :type page: str
478
+ :param limit: When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
479
+ :type limit: int
480
+ :param filter: Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
481
+ :type filter: str
482
+ :param sort_by: A list of field names suffixed by \" ASC\" or \" DESC\"
483
+ :type sort_by: List[str]
484
+ :param async_req: Whether to execute the request asynchronously.
485
+ :type async_req: bool, optional
486
+ :param _preload_content: if False, the ApiResponse.data will
487
+ be set to none and raw_data will store the
488
+ HTTP response body without reading/decoding.
489
+ Default is True.
490
+ :type _preload_content: bool, optional
491
+ :param _return_http_data_only: response data instead of ApiResponse
492
+ object with status code, headers, etc
493
+ :type _return_http_data_only: bool, optional
494
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
495
+ :param opts: Configuration options for this request
496
+ :type opts: ConfigurationOptions, optional
497
+ :param _request_auth: set to override the auth_settings for an a single
498
+ request; this effectively ignores the authentication
499
+ in the spec for a single request.
500
+ :type _request_auth: dict, optional
501
+ :type _content_type: string, optional: force content-type for the request
502
+ :return: Returns the result object.
503
+ If the method is called asynchronously,
504
+ returns the request thread.
505
+ :rtype: tuple(ResourceListOfChangeInterval, status_code(int), headers(HTTPHeaderDict))
506
+ """
507
+
508
+ _params = locals()
509
+
510
+ _all_params = [
511
+ 'entity_type',
512
+ 'entity_unique_id',
513
+ 'as_at',
514
+ 'page',
515
+ 'limit',
516
+ 'filter',
517
+ 'sort_by'
518
+ ]
519
+ _all_params.extend(
520
+ [
521
+ 'async_req',
522
+ '_return_http_data_only',
523
+ '_preload_content',
524
+ '_request_timeout',
525
+ '_request_auth',
526
+ '_content_type',
527
+ '_headers',
528
+ 'opts'
529
+ ]
530
+ )
531
+
532
+ # validate the arguments
533
+ for _key, _val in _params['kwargs'].items():
534
+ if _key not in _all_params:
535
+ raise ApiTypeError(
536
+ "Got an unexpected keyword argument '%s'"
537
+ " to method get_entity_history" % _key
538
+ )
539
+ _params[_key] = _val
540
+ del _params['kwargs']
541
+
542
+ _collection_formats = {}
543
+
544
+ # process the path parameters
545
+ _path_params = {}
546
+ if _params['entity_type']:
547
+ _path_params['entityType'] = _params['entity_type']
548
+
549
+ if _params['entity_unique_id']:
550
+ _path_params['entityUniqueId'] = _params['entity_unique_id']
551
+
552
+
553
+ # process the query parameters
554
+ _query_params = []
555
+ if _params.get('as_at') is not None: # noqa: E501
556
+ if isinstance(_params['as_at'], datetime):
557
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
558
+ else:
559
+ _query_params.append(('asAt', _params['as_at']))
560
+
561
+ if _params.get('page') is not None: # noqa: E501
562
+ _query_params.append(('page', _params['page']))
563
+
564
+ if _params.get('limit') is not None: # noqa: E501
565
+ _query_params.append(('limit', _params['limit']))
566
+
567
+ if _params.get('filter') is not None: # noqa: E501
568
+ _query_params.append(('filter', _params['filter']))
569
+
570
+ if _params.get('sort_by') is not None: # noqa: E501
571
+ _query_params.append(('sortBy', _params['sort_by']))
572
+ _collection_formats['sortBy'] = 'multi'
573
+
574
+ # process the header parameters
575
+ _header_params = dict(_params.get('_headers', {}))
576
+ # process the form parameters
577
+ _form_params = []
578
+ _files = {}
579
+ # process the body parameter
580
+ _body_params = None
581
+ # set the HTTP header `Accept`
582
+ _header_params['Accept'] = self.api_client.select_header_accept(
583
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
584
+
585
+ # authentication setting
586
+ _auth_settings = ['oauth2'] # noqa: E501
587
+
588
+ _response_types_map = {
589
+ '200': "ResourceListOfChangeInterval",
590
+ '400': "LusidValidationProblemDetails",
591
+ }
592
+
593
+ return self.api_client.call_api(
594
+ '/api/entities/{entityType}/{entityUniqueId}/history', 'GET',
595
+ _path_params,
596
+ _query_params,
597
+ _header_params,
598
+ body=_body_params,
599
+ post_params=_form_params,
600
+ files=_files,
601
+ response_types_map=_response_types_map,
602
+ auth_settings=_auth_settings,
603
+ async_req=_params.get('async_req'),
604
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
605
+ _preload_content=_params.get('_preload_content', True),
606
+ _request_timeout=_params.get('_request_timeout'),
607
+ opts=_params.get('opts'),
223
608
  collection_formats=_collection_formats,
224
609
  _request_auth=_params.get('_request_auth'))
225
610
 
@@ -252,10 +637,9 @@ class EntitiesApi:
252
637
  :type previews: List[str]
253
638
  :param async_req: Whether to execute the request asynchronously.
254
639
  :type async_req: bool, optional
255
- :param _request_timeout: timeout setting for this request.
256
- If one number provided, it will be total request
257
- timeout. It can also be a pair (tuple) of
258
- (connection, read) timeouts.
640
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
641
+ :param opts: Configuration options for this request
642
+ :type opts: ConfigurationOptions, optional
259
643
  :return: Returns the result object.
260
644
  If the method is called asynchronously,
261
645
  returns the request thread.
@@ -298,10 +682,9 @@ class EntitiesApi:
298
682
  :param _return_http_data_only: response data instead of ApiResponse
299
683
  object with status code, headers, etc
300
684
  :type _return_http_data_only: bool, optional
301
- :param _request_timeout: timeout setting for this request. If one
302
- number provided, it will be total request
303
- timeout. It can also be a pair (tuple) of
304
- (connection, read) timeouts.
685
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
686
+ :param opts: Configuration options for this request
687
+ :type opts: ConfigurationOptions, optional
305
688
  :param _request_auth: set to override the auth_settings for an a single
306
689
  request; this effectively ignores the authentication
307
690
  in the spec for a single request.
@@ -329,7 +712,8 @@ class EntitiesApi:
329
712
  '_request_timeout',
330
713
  '_request_auth',
331
714
  '_content_type',
332
- '_headers'
715
+ '_headers',
716
+ 'opts'
333
717
  ]
334
718
  )
335
719
 
@@ -399,6 +783,7 @@ class EntitiesApi:
399
783
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
400
784
  _preload_content=_params.get('_preload_content', True),
401
785
  _request_timeout=_params.get('_request_timeout'),
786
+ opts=_params.get('opts'),
402
787
  collection_formats=_collection_formats,
403
788
  _request_auth=_params.get('_request_auth'))
404
789
 
@@ -431,10 +816,9 @@ class EntitiesApi:
431
816
  :type previews: List[str]
432
817
  :param async_req: Whether to execute the request asynchronously.
433
818
  :type async_req: bool, optional
434
- :param _request_timeout: timeout setting for this request.
435
- If one number provided, it will be total request
436
- timeout. It can also be a pair (tuple) of
437
- (connection, read) timeouts.
819
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
820
+ :param opts: Configuration options for this request
821
+ :type opts: ConfigurationOptions, optional
438
822
  :return: Returns the result object.
439
823
  If the method is called asynchronously,
440
824
  returns the request thread.
@@ -477,10 +861,9 @@ class EntitiesApi:
477
861
  :param _return_http_data_only: response data instead of ApiResponse
478
862
  object with status code, headers, etc
479
863
  :type _return_http_data_only: bool, optional
480
- :param _request_timeout: timeout setting for this request. If one
481
- number provided, it will be total request
482
- timeout. It can also be a pair (tuple) of
483
- (connection, read) timeouts.
864
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
865
+ :param opts: Configuration options for this request
866
+ :type opts: ConfigurationOptions, optional
484
867
  :param _request_auth: set to override the auth_settings for an a single
485
868
  request; this effectively ignores the authentication
486
869
  in the spec for a single request.
@@ -508,7 +891,8 @@ class EntitiesApi:
508
891
  '_request_timeout',
509
892
  '_request_auth',
510
893
  '_content_type',
511
- '_headers'
894
+ '_headers',
895
+ 'opts'
512
896
  ]
513
897
  )
514
898
 
@@ -578,6 +962,7 @@ class EntitiesApi:
578
962
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
579
963
  _preload_content=_params.get('_preload_content', True),
580
964
  _request_timeout=_params.get('_request_timeout'),
965
+ opts=_params.get('opts'),
581
966
  collection_formats=_collection_formats,
582
967
  _request_auth=_params.get('_request_auth'))
583
968
 
@@ -608,10 +993,9 @@ class EntitiesApi:
608
993
  :type as_at: datetime
609
994
  :param async_req: Whether to execute the request asynchronously.
610
995
  :type async_req: bool, optional
611
- :param _request_timeout: timeout setting for this request.
612
- If one number provided, it will be total request
613
- timeout. It can also be a pair (tuple) of
614
- (connection, read) timeouts.
996
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
997
+ :param opts: Configuration options for this request
998
+ :type opts: ConfigurationOptions, optional
615
999
  :return: Returns the result object.
616
1000
  If the method is called asynchronously,
617
1001
  returns the request thread.
@@ -652,10 +1036,9 @@ class EntitiesApi:
652
1036
  :param _return_http_data_only: response data instead of ApiResponse
653
1037
  object with status code, headers, etc
654
1038
  :type _return_http_data_only: bool, optional
655
- :param _request_timeout: timeout setting for this request. If one
656
- number provided, it will be total request
657
- timeout. It can also be a pair (tuple) of
658
- (connection, read) timeouts.
1039
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1040
+ :param opts: Configuration options for this request
1041
+ :type opts: ConfigurationOptions, optional
659
1042
  :param _request_auth: set to override the auth_settings for an a single
660
1043
  request; this effectively ignores the authentication
661
1044
  in the spec for a single request.
@@ -682,7 +1065,8 @@ class EntitiesApi:
682
1065
  '_request_timeout',
683
1066
  '_request_auth',
684
1067
  '_content_type',
685
- '_headers'
1068
+ '_headers',
1069
+ 'opts'
686
1070
  ]
687
1071
  )
688
1072
 
@@ -748,6 +1132,7 @@ class EntitiesApi:
748
1132
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
749
1133
  _preload_content=_params.get('_preload_content', True),
750
1134
  _request_timeout=_params.get('_request_timeout'),
1135
+ opts=_params.get('opts'),
751
1136
  collection_formats=_collection_formats,
752
1137
  _request_auth=_params.get('_request_auth'))
753
1138
 
@@ -780,10 +1165,9 @@ class EntitiesApi:
780
1165
  :type previews: List[str]
781
1166
  :param async_req: Whether to execute the request asynchronously.
782
1167
  :type async_req: bool, optional
783
- :param _request_timeout: timeout setting for this request.
784
- If one number provided, it will be total request
785
- timeout. It can also be a pair (tuple) of
786
- (connection, read) timeouts.
1168
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1169
+ :param opts: Configuration options for this request
1170
+ :type opts: ConfigurationOptions, optional
787
1171
  :return: Returns the result object.
788
1172
  If the method is called asynchronously,
789
1173
  returns the request thread.
@@ -826,10 +1210,9 @@ class EntitiesApi:
826
1210
  :param _return_http_data_only: response data instead of ApiResponse
827
1211
  object with status code, headers, etc
828
1212
  :type _return_http_data_only: bool, optional
829
- :param _request_timeout: timeout setting for this request. If one
830
- number provided, it will be total request
831
- timeout. It can also be a pair (tuple) of
832
- (connection, read) timeouts.
1213
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
1214
+ :param opts: Configuration options for this request
1215
+ :type opts: ConfigurationOptions, optional
833
1216
  :param _request_auth: set to override the auth_settings for an a single
834
1217
  request; this effectively ignores the authentication
835
1218
  in the spec for a single request.
@@ -857,7 +1240,8 @@ class EntitiesApi:
857
1240
  '_request_timeout',
858
1241
  '_request_auth',
859
1242
  '_content_type',
860
- '_headers'
1243
+ '_headers',
1244
+ 'opts'
861
1245
  ]
862
1246
  )
863
1247
 
@@ -927,5 +1311,6 @@ class EntitiesApi:
927
1311
  _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
928
1312
  _preload_content=_params.get('_preload_content', True),
929
1313
  _request_timeout=_params.get('_request_timeout'),
1314
+ opts=_params.get('opts'),
930
1315
  collection_formats=_collection_formats,
931
1316
  _request_auth=_params.get('_request_auth'))