lusid-sdk 2.1.242__py3-none-any.whl → 2.1.261__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 (63) hide show
  1. lusid/__init__.py +28 -0
  2. lusid/api/__init__.py +2 -0
  3. lusid/api/entities_api.py +360 -0
  4. lusid/api/fee_types_api.py +143 -0
  5. lusid/api/fund_configurations_api.py +944 -0
  6. lusid/api/order_management_api.py +320 -1
  7. lusid/configuration.py +1 -1
  8. lusid/models/__init__.py +26 -0
  9. lusid/models/accounting_method.py +3 -0
  10. lusid/models/accumulation_event.py +3 -3
  11. lusid/models/amortisation_event.py +3 -3
  12. lusid/models/bond_coupon_event.py +3 -3
  13. lusid/models/bond_default_event.py +3 -3
  14. lusid/models/bond_principal_event.py +3 -3
  15. lusid/models/cancel_placements_response.py +153 -0
  16. lusid/models/cancelled_placement_result.py +83 -0
  17. lusid/models/capital_distribution_event.py +3 -3
  18. lusid/models/cash_dividend_event.py +3 -3
  19. lusid/models/cash_flow_event.py +3 -3
  20. lusid/models/close_event.py +3 -3
  21. lusid/models/component_rule.py +83 -0
  22. lusid/models/create_derived_transaction_portfolio_request.py +3 -3
  23. lusid/models/create_transaction_portfolio_request.py +3 -3
  24. lusid/models/dependency_source_filter.py +9 -2
  25. lusid/models/dividend_option_event.py +3 -3
  26. lusid/models/dividend_reinvestment_event.py +3 -3
  27. lusid/models/exercise_event.py +3 -3
  28. lusid/models/expiry_event.py +3 -3
  29. lusid/models/fee_transaction_template_specification.py +79 -0
  30. lusid/models/fund_configuration.py +150 -0
  31. lusid/models/fund_configuration_properties.py +115 -0
  32. lusid/models/fund_configuration_request.py +130 -0
  33. lusid/models/future_expiry_event.py +100 -0
  34. lusid/models/fx_forward_settlement_event.py +3 -3
  35. lusid/models/informational_error_event.py +3 -3
  36. lusid/models/informational_event.py +3 -3
  37. lusid/models/instrument_entity.py +146 -0
  38. lusid/models/instrument_event.py +6 -5
  39. lusid/models/instrument_event_type.py +1 -0
  40. lusid/models/maturity_event.py +3 -3
  41. lusid/models/merger_event.py +3 -3
  42. lusid/models/open_event.py +3 -3
  43. lusid/models/paged_resource_list_of_fund_configuration.py +113 -0
  44. lusid/models/placement_update_request.py +116 -0
  45. lusid/models/portfolio.py +3 -3
  46. lusid/models/portfolio_details.py +3 -3
  47. lusid/models/portfolio_without_href.py +3 -3
  48. lusid/models/property_definition.py +7 -1
  49. lusid/models/property_definition_entity.py +146 -0
  50. lusid/models/raw_vendor_event.py +3 -3
  51. lusid/models/reset_event.py +3 -3
  52. lusid/models/reverse_stock_split_event.py +3 -3
  53. lusid/models/scrip_dividend_event.py +3 -3
  54. lusid/models/spin_off_event.py +3 -3
  55. lusid/models/stock_dividend_event.py +3 -3
  56. lusid/models/stock_split_event.py +3 -3
  57. lusid/models/transaction_field_map.py +7 -2
  58. lusid/models/transition_event.py +3 -3
  59. lusid/models/trigger_event.py +3 -3
  60. lusid/models/update_placements_response.py +153 -0
  61. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.261.dist-info}/METADATA +26 -3
  62. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.261.dist-info}/RECORD +63 -49
  63. {lusid_sdk-2.1.242.dist-info → lusid_sdk-2.1.261.dist-info}/WHEEL +0 -0
lusid/__init__.py CHANGED
@@ -42,6 +42,7 @@ from lusid.api.derived_transaction_portfolios_api import DerivedTransactionPortf
42
42
  from lusid.api.entities_api import EntitiesApi
43
43
  from lusid.api.executions_api import ExecutionsApi
44
44
  from lusid.api.fee_types_api import FeeTypesApi
45
+ from lusid.api.fund_configurations_api import FundConfigurationsApi
45
46
  from lusid.api.funds_api import FundsApi
46
47
  from lusid.api.instrument_event_types_api import InstrumentEventTypesApi
47
48
  from lusid.api.instrument_events_api import InstrumentEventsApi
@@ -184,6 +185,8 @@ from lusid.models.calculation_info import CalculationInfo
184
185
  from lusid.models.calendar import Calendar
185
186
  from lusid.models.calendar_date import CalendarDate
186
187
  from lusid.models.calendar_dependency import CalendarDependency
188
+ from lusid.models.cancel_placements_response import CancelPlacementsResponse
189
+ from lusid.models.cancelled_placement_result import CancelledPlacementResult
187
190
  from lusid.models.cap_floor import CapFloor
188
191
  from lusid.models.capital_distribution_event import CapitalDistributionEvent
189
192
  from lusid.models.cash_and_security_offer_election import CashAndSecurityOfferElection
@@ -250,6 +253,7 @@ from lusid.models.compliance_template_parameter import ComplianceTemplateParamet
250
253
  from lusid.models.compliance_template_variation import ComplianceTemplateVariation
251
254
  from lusid.models.compliance_template_variation_dto import ComplianceTemplateVariationDto
252
255
  from lusid.models.compliance_template_variation_request import ComplianceTemplateVariationRequest
256
+ from lusid.models.component_rule import ComponentRule
253
257
  from lusid.models.component_transaction import ComponentTransaction
254
258
  from lusid.models.composite_breakdown import CompositeBreakdown
255
259
  from lusid.models.composite_breakdown_request import CompositeBreakdownRequest
@@ -395,6 +399,7 @@ from lusid.models.fee_request import FeeRequest
395
399
  from lusid.models.fee_rule import FeeRule
396
400
  from lusid.models.fee_rule_upsert_request import FeeRuleUpsertRequest
397
401
  from lusid.models.fee_rule_upsert_response import FeeRuleUpsertResponse
402
+ from lusid.models.fee_transaction_template_specification import FeeTransactionTemplateSpecification
398
403
  from lusid.models.fee_type import FeeType
399
404
  from lusid.models.fee_type_request import FeeTypeRequest
400
405
  from lusid.models.field_definition import FieldDefinition
@@ -415,12 +420,16 @@ from lusid.models.flow_conventions import FlowConventions
415
420
  from lusid.models.forward_rate_agreement import ForwardRateAgreement
416
421
  from lusid.models.from_recipe import FromRecipe
417
422
  from lusid.models.fund import Fund
423
+ from lusid.models.fund_configuration import FundConfiguration
424
+ from lusid.models.fund_configuration_properties import FundConfigurationProperties
425
+ from lusid.models.fund_configuration_request import FundConfigurationRequest
418
426
  from lusid.models.fund_properties import FundProperties
419
427
  from lusid.models.fund_request import FundRequest
420
428
  from lusid.models.fund_share_class import FundShareClass
421
429
  from lusid.models.funding_leg import FundingLeg
422
430
  from lusid.models.funding_leg_options import FundingLegOptions
423
431
  from lusid.models.future import Future
432
+ from lusid.models.future_expiry_event import FutureExpiryEvent
424
433
  from lusid.models.futures_contract_details import FuturesContractDetails
425
434
  from lusid.models.fx_conventions import FxConventions
426
435
  from lusid.models.fx_dependency import FxDependency
@@ -495,6 +504,7 @@ from lusid.models.instrument_cash_flow import InstrumentCashFlow
495
504
  from lusid.models.instrument_definition import InstrumentDefinition
496
505
  from lusid.models.instrument_definition_format import InstrumentDefinitionFormat
497
506
  from lusid.models.instrument_delete_modes import InstrumentDeleteModes
507
+ from lusid.models.instrument_entity import InstrumentEntity
498
508
  from lusid.models.instrument_event import InstrumentEvent
499
509
  from lusid.models.instrument_event_configuration import InstrumentEventConfiguration
500
510
  from lusid.models.instrument_event_holder import InstrumentEventHolder
@@ -644,6 +654,7 @@ from lusid.models.paged_resource_list_of_execution import PagedResourceListOfExe
644
654
  from lusid.models.paged_resource_list_of_fee import PagedResourceListOfFee
645
655
  from lusid.models.paged_resource_list_of_fee_type import PagedResourceListOfFeeType
646
656
  from lusid.models.paged_resource_list_of_fund import PagedResourceListOfFund
657
+ from lusid.models.paged_resource_list_of_fund_configuration import PagedResourceListOfFundConfiguration
647
658
  from lusid.models.paged_resource_list_of_general_ledger_profile_response import PagedResourceListOfGeneralLedgerProfileResponse
648
659
  from lusid.models.paged_resource_list_of_instrument import PagedResourceListOfInstrument
649
660
  from lusid.models.paged_resource_list_of_instrument_event_holder import PagedResourceListOfInstrumentEventHolder
@@ -691,6 +702,7 @@ from lusid.models.place_blocks_request import PlaceBlocksRequest
691
702
  from lusid.models.placement import Placement
692
703
  from lusid.models.placement_request import PlacementRequest
693
704
  from lusid.models.placement_set_request import PlacementSetRequest
705
+ from lusid.models.placement_update_request import PlacementUpdateRequest
694
706
  from lusid.models.portfolio import Portfolio
695
707
  from lusid.models.portfolio_cash_flow import PortfolioCashFlow
696
708
  from lusid.models.portfolio_cash_ladder import PortfolioCashLadder
@@ -727,6 +739,7 @@ from lusid.models.pricing_model import PricingModel
727
739
  from lusid.models.pricing_options import PricingOptions
728
740
  from lusid.models.processed_command import ProcessedCommand
729
741
  from lusid.models.property_definition import PropertyDefinition
742
+ from lusid.models.property_definition_entity import PropertyDefinitionEntity
730
743
  from lusid.models.property_definition_search_result import PropertyDefinitionSearchResult
731
744
  from lusid.models.property_definition_type import PropertyDefinitionType
732
745
  from lusid.models.property_domain import PropertyDomain
@@ -1006,6 +1019,7 @@ from lusid.models.update_data_type_request import UpdateDataTypeRequest
1006
1019
  from lusid.models.update_derived_property_definition_request import UpdateDerivedPropertyDefinitionRequest
1007
1020
  from lusid.models.update_fee_type_request import UpdateFeeTypeRequest
1008
1021
  from lusid.models.update_instrument_identifier_request import UpdateInstrumentIdentifierRequest
1022
+ from lusid.models.update_placements_response import UpdatePlacementsResponse
1009
1023
  from lusid.models.update_portfolio_group_request import UpdatePortfolioGroupRequest
1010
1024
  from lusid.models.update_portfolio_request import UpdatePortfolioRequest
1011
1025
  from lusid.models.update_property_definition_request import UpdatePropertyDefinitionRequest
@@ -1128,6 +1142,7 @@ __all__ = [
1128
1142
  "EntitiesApi",
1129
1143
  "ExecutionsApi",
1130
1144
  "FeeTypesApi",
1145
+ "FundConfigurationsApi",
1131
1146
  "FundsApi",
1132
1147
  "InstrumentEventTypesApi",
1133
1148
  "InstrumentEventsApi",
@@ -1260,6 +1275,8 @@ __all__ = [
1260
1275
  "Calendar",
1261
1276
  "CalendarDate",
1262
1277
  "CalendarDependency",
1278
+ "CancelPlacementsResponse",
1279
+ "CancelledPlacementResult",
1263
1280
  "CapFloor",
1264
1281
  "CapitalDistributionEvent",
1265
1282
  "CashAndSecurityOfferElection",
@@ -1326,6 +1343,7 @@ __all__ = [
1326
1343
  "ComplianceTemplateVariation",
1327
1344
  "ComplianceTemplateVariationDto",
1328
1345
  "ComplianceTemplateVariationRequest",
1346
+ "ComponentRule",
1329
1347
  "ComponentTransaction",
1330
1348
  "CompositeBreakdown",
1331
1349
  "CompositeBreakdownRequest",
@@ -1471,6 +1489,7 @@ __all__ = [
1471
1489
  "FeeRule",
1472
1490
  "FeeRuleUpsertRequest",
1473
1491
  "FeeRuleUpsertResponse",
1492
+ "FeeTransactionTemplateSpecification",
1474
1493
  "FeeType",
1475
1494
  "FeeTypeRequest",
1476
1495
  "FieldDefinition",
@@ -1491,12 +1510,16 @@ __all__ = [
1491
1510
  "ForwardRateAgreement",
1492
1511
  "FromRecipe",
1493
1512
  "Fund",
1513
+ "FundConfiguration",
1514
+ "FundConfigurationProperties",
1515
+ "FundConfigurationRequest",
1494
1516
  "FundProperties",
1495
1517
  "FundRequest",
1496
1518
  "FundShareClass",
1497
1519
  "FundingLeg",
1498
1520
  "FundingLegOptions",
1499
1521
  "Future",
1522
+ "FutureExpiryEvent",
1500
1523
  "FuturesContractDetails",
1501
1524
  "FxConventions",
1502
1525
  "FxDependency",
@@ -1571,6 +1594,7 @@ __all__ = [
1571
1594
  "InstrumentDefinition",
1572
1595
  "InstrumentDefinitionFormat",
1573
1596
  "InstrumentDeleteModes",
1597
+ "InstrumentEntity",
1574
1598
  "InstrumentEvent",
1575
1599
  "InstrumentEventConfiguration",
1576
1600
  "InstrumentEventHolder",
@@ -1720,6 +1744,7 @@ __all__ = [
1720
1744
  "PagedResourceListOfFee",
1721
1745
  "PagedResourceListOfFeeType",
1722
1746
  "PagedResourceListOfFund",
1747
+ "PagedResourceListOfFundConfiguration",
1723
1748
  "PagedResourceListOfGeneralLedgerProfileResponse",
1724
1749
  "PagedResourceListOfInstrument",
1725
1750
  "PagedResourceListOfInstrumentEventHolder",
@@ -1767,6 +1792,7 @@ __all__ = [
1767
1792
  "Placement",
1768
1793
  "PlacementRequest",
1769
1794
  "PlacementSetRequest",
1795
+ "PlacementUpdateRequest",
1770
1796
  "Portfolio",
1771
1797
  "PortfolioCashFlow",
1772
1798
  "PortfolioCashLadder",
@@ -1803,6 +1829,7 @@ __all__ = [
1803
1829
  "PricingOptions",
1804
1830
  "ProcessedCommand",
1805
1831
  "PropertyDefinition",
1832
+ "PropertyDefinitionEntity",
1806
1833
  "PropertyDefinitionSearchResult",
1807
1834
  "PropertyDefinitionType",
1808
1835
  "PropertyDomain",
@@ -2082,6 +2109,7 @@ __all__ = [
2082
2109
  "UpdateDerivedPropertyDefinitionRequest",
2083
2110
  "UpdateFeeTypeRequest",
2084
2111
  "UpdateInstrumentIdentifierRequest",
2112
+ "UpdatePlacementsResponse",
2085
2113
  "UpdatePortfolioGroupRequest",
2086
2114
  "UpdatePortfolioRequest",
2087
2115
  "UpdatePropertyDefinitionRequest",
lusid/api/__init__.py CHANGED
@@ -26,6 +26,7 @@ from lusid.api.derived_transaction_portfolios_api import DerivedTransactionPortf
26
26
  from lusid.api.entities_api import EntitiesApi
27
27
  from lusid.api.executions_api import ExecutionsApi
28
28
  from lusid.api.fee_types_api import FeeTypesApi
29
+ from lusid.api.fund_configurations_api import FundConfigurationsApi
29
30
  from lusid.api.funds_api import FundsApi
30
31
  from lusid.api.instrument_event_types_api import InstrumentEventTypesApi
31
32
  from lusid.api.instrument_events_api import InstrumentEventsApi
@@ -94,6 +95,7 @@ __all__ = [
94
95
  "EntitiesApi",
95
96
  "ExecutionsApi",
96
97
  "FeeTypesApi",
98
+ "FundConfigurationsApi",
97
99
  "FundsApi",
98
100
  "InstrumentEventTypesApi",
99
101
  "InstrumentEventsApi",
lusid/api/entities_api.py CHANGED
@@ -26,7 +26,9 @@ from pydantic.v1 import Field, StrictStr, conlist, constr, validator
26
26
 
27
27
  from typing import Optional
28
28
 
29
+ from lusid.models.instrument_entity import InstrumentEntity
29
30
  from lusid.models.portfolio_entity import PortfolioEntity
31
+ from lusid.models.property_definition_entity import PropertyDefinitionEntity
30
32
  from lusid.models.resource_list_of_change import ResourceListOfChange
31
33
 
32
34
  from lusid.api_client import ApiClient
@@ -49,6 +51,185 @@ class EntitiesApi:
49
51
  api_client = ApiClient.get_default()
50
52
  self.api_client = api_client
51
53
 
54
+ @overload
55
+ async def get_instrument_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 instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument 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) -> InstrumentEntity: # noqa: E501
56
+ ...
57
+
58
+ @overload
59
+ def get_instrument_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 instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument 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, async_req: Optional[bool]=True, **kwargs) -> InstrumentEntity: # noqa: E501
60
+ ...
61
+
62
+ @validate_arguments
63
+ def get_instrument_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 instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument 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, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentEntity, Awaitable[InstrumentEntity]]: # noqa: E501
64
+ """[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
65
+
66
+ Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. # noqa: E501
67
+ This method makes a synchronous HTTP request by default. To make an
68
+ asynchronous HTTP request, please pass async_req=True
69
+
70
+ >>> thread = api.get_instrument_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True)
71
+ >>> result = thread.get()
72
+
73
+ :param entity_unique_id: The universally unique identifier of the instrument definition. (required)
74
+ :type entity_unique_id: str
75
+ :param effective_at: The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.
76
+ :type effective_at: str
77
+ :param as_at: The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified.
78
+ :type as_at: datetime
79
+ :param previews: The ids of the staged modifications to be previewed in the response.
80
+ :type previews: List[str]
81
+ :param async_req: Whether to execute the request asynchronously.
82
+ :type async_req: bool, optional
83
+ :param _request_timeout: timeout setting for this request.
84
+ If one number provided, it will be total request
85
+ timeout. It can also be a pair (tuple) of
86
+ (connection, read) timeouts.
87
+ :return: Returns the result object.
88
+ If the method is called asynchronously,
89
+ returns the request thread.
90
+ :rtype: InstrumentEntity
91
+ """
92
+ kwargs['_return_http_data_only'] = True
93
+ if '_preload_content' in kwargs:
94
+ message = "Error! Please call the get_instrument_by_entity_unique_id_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
95
+ raise ValueError(message)
96
+ if async_req is not None:
97
+ kwargs['async_req'] = async_req
98
+ return self.get_instrument_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
99
+
100
+ @validate_arguments
101
+ def get_instrument_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 instrument definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument 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) -> ApiResponse: # noqa: E501
102
+ """[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
103
+
104
+ Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to deletion. # noqa: E501
105
+ This method makes a synchronous HTTP request by default. To make an
106
+ asynchronous HTTP request, please pass async_req=True
107
+
108
+ >>> thread = api.get_instrument_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True)
109
+ >>> result = thread.get()
110
+
111
+ :param entity_unique_id: The universally unique identifier of the instrument definition. (required)
112
+ :type entity_unique_id: str
113
+ :param effective_at: The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.
114
+ :type effective_at: str
115
+ :param as_at: The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified.
116
+ :type as_at: datetime
117
+ :param previews: The ids of the staged modifications to be previewed in the response.
118
+ :type previews: List[str]
119
+ :param async_req: Whether to execute the request asynchronously.
120
+ :type async_req: bool, optional
121
+ :param _preload_content: if False, the ApiResponse.data will
122
+ be set to none and raw_data will store the
123
+ HTTP response body without reading/decoding.
124
+ Default is True.
125
+ :type _preload_content: bool, optional
126
+ :param _return_http_data_only: response data instead of ApiResponse
127
+ object with status code, headers, etc
128
+ :type _return_http_data_only: bool, optional
129
+ :param _request_timeout: timeout setting for this request. If one
130
+ number provided, it will be total request
131
+ timeout. It can also be a pair (tuple) of
132
+ (connection, read) timeouts.
133
+ :param _request_auth: set to override the auth_settings for an a single
134
+ request; this effectively ignores the authentication
135
+ in the spec for a single request.
136
+ :type _request_auth: dict, optional
137
+ :type _content_type: string, optional: force content-type for the request
138
+ :return: Returns the result object.
139
+ If the method is called asynchronously,
140
+ returns the request thread.
141
+ :rtype: tuple(InstrumentEntity, status_code(int), headers(HTTPHeaderDict))
142
+ """
143
+
144
+ _params = locals()
145
+
146
+ _all_params = [
147
+ 'entity_unique_id',
148
+ 'effective_at',
149
+ 'as_at',
150
+ 'previews'
151
+ ]
152
+ _all_params.extend(
153
+ [
154
+ 'async_req',
155
+ '_return_http_data_only',
156
+ '_preload_content',
157
+ '_request_timeout',
158
+ '_request_auth',
159
+ '_content_type',
160
+ '_headers'
161
+ ]
162
+ )
163
+
164
+ # validate the arguments
165
+ for _key, _val in _params['kwargs'].items():
166
+ if _key not in _all_params:
167
+ raise ApiTypeError(
168
+ "Got an unexpected keyword argument '%s'"
169
+ " to method get_instrument_by_entity_unique_id" % _key
170
+ )
171
+ _params[_key] = _val
172
+ del _params['kwargs']
173
+
174
+ _collection_formats = {}
175
+
176
+ # process the path parameters
177
+ _path_params = {}
178
+ if _params['entity_unique_id']:
179
+ _path_params['entityUniqueId'] = _params['entity_unique_id']
180
+
181
+
182
+ # process the query parameters
183
+ _query_params = []
184
+ if _params.get('effective_at') is not None: # noqa: E501
185
+ _query_params.append(('effectiveAt', _params['effective_at']))
186
+
187
+ if _params.get('as_at') is not None: # noqa: E501
188
+ if isinstance(_params['as_at'], datetime):
189
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
190
+ else:
191
+ _query_params.append(('asAt', _params['as_at']))
192
+
193
+ if _params.get('previews') is not None: # noqa: E501
194
+ _query_params.append(('previews', _params['previews']))
195
+ _collection_formats['previews'] = 'multi'
196
+
197
+ # process the header parameters
198
+ _header_params = dict(_params.get('_headers', {}))
199
+ # process the form parameters
200
+ _form_params = []
201
+ _files = {}
202
+ # process the body parameter
203
+ _body_params = None
204
+ # set the HTTP header `Accept`
205
+ _header_params['Accept'] = self.api_client.select_header_accept(
206
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
207
+
208
+ # authentication setting
209
+ _auth_settings = ['oauth2'] # noqa: E501
210
+
211
+ _response_types_map = {
212
+ '200': "InstrumentEntity",
213
+ '400': "LusidValidationProblemDetails",
214
+ }
215
+
216
+ return self.api_client.call_api(
217
+ '/api/entities/instruments/{entityUniqueId}', 'GET',
218
+ _path_params,
219
+ _query_params,
220
+ _header_params,
221
+ body=_body_params,
222
+ post_params=_form_params,
223
+ files=_files,
224
+ response_types_map=_response_types_map,
225
+ auth_settings=_auth_settings,
226
+ async_req=_params.get('async_req'),
227
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
228
+ _preload_content=_params.get('_preload_content', True),
229
+ _request_timeout=_params.get('_request_timeout'),
230
+ collection_formats=_collection_formats,
231
+ _request_auth=_params.get('_request_auth'))
232
+
52
233
  @overload
53
234
  async def get_portfolio_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 portfolio definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the portfolio definition. 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 portfolio definition. Defaults to returning the latest version of the portfolio 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) -> PortfolioEntity: # noqa: E501
54
235
  ...
@@ -397,3 +578,182 @@ class EntitiesApi:
397
578
  _request_timeout=_params.get('_request_timeout'),
398
579
  collection_formats=_collection_formats,
399
580
  _request_auth=_params.get('_request_auth'))
581
+
582
+ @overload
583
+ async def get_property_definition_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 property definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property 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) -> PropertyDefinitionEntity: # noqa: E501
584
+ ...
585
+
586
+ @overload
587
+ def get_property_definition_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 property definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property 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, async_req: Optional[bool]=True, **kwargs) -> PropertyDefinitionEntity: # noqa: E501
588
+ ...
589
+
590
+ @validate_arguments
591
+ def get_property_definition_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 property definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property 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, async_req: Optional[bool]=None, **kwargs) -> Union[PropertyDefinitionEntity, Awaitable[PropertyDefinitionEntity]]: # noqa: E501
592
+ """[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
593
+
594
+ Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. # noqa: E501
595
+ This method makes a synchronous HTTP request by default. To make an
596
+ asynchronous HTTP request, please pass async_req=True
597
+
598
+ >>> thread = api.get_property_definition_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True)
599
+ >>> result = thread.get()
600
+
601
+ :param entity_unique_id: The universally unique identifier of the property definition. (required)
602
+ :type entity_unique_id: str
603
+ :param effective_at: The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified.
604
+ :type effective_at: str
605
+ :param as_at: The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified.
606
+ :type as_at: datetime
607
+ :param previews: The ids of the staged modifications to be previewed in the response.
608
+ :type previews: List[str]
609
+ :param async_req: Whether to execute the request asynchronously.
610
+ :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.
615
+ :return: Returns the result object.
616
+ If the method is called asynchronously,
617
+ returns the request thread.
618
+ :rtype: PropertyDefinitionEntity
619
+ """
620
+ kwargs['_return_http_data_only'] = True
621
+ if '_preload_content' in kwargs:
622
+ message = "Error! Please call the get_property_definition_by_entity_unique_id_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
623
+ raise ValueError(message)
624
+ if async_req is not None:
625
+ kwargs['async_req'] = async_req
626
+ return self.get_property_definition_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, **kwargs) # noqa: E501
627
+
628
+ @validate_arguments
629
+ def get_property_definition_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 property definition.")], effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime at which to retrieve the property definition. 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 property definition. Defaults to returning the latest version of the property 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) -> ApiResponse: # noqa: E501
630
+ """[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
631
+
632
+ Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to deletion. # noqa: E501
633
+ This method makes a synchronous HTTP request by default. To make an
634
+ asynchronous HTTP request, please pass async_req=True
635
+
636
+ >>> thread = api.get_property_definition_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True)
637
+ >>> result = thread.get()
638
+
639
+ :param entity_unique_id: The universally unique identifier of the property definition. (required)
640
+ :type entity_unique_id: str
641
+ :param effective_at: The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified.
642
+ :type effective_at: str
643
+ :param as_at: The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified.
644
+ :type as_at: datetime
645
+ :param previews: The ids of the staged modifications to be previewed in the response.
646
+ :type previews: List[str]
647
+ :param async_req: Whether to execute the request asynchronously.
648
+ :type async_req: bool, optional
649
+ :param _preload_content: if False, the ApiResponse.data will
650
+ be set to none and raw_data will store the
651
+ HTTP response body without reading/decoding.
652
+ Default is True.
653
+ :type _preload_content: bool, optional
654
+ :param _return_http_data_only: response data instead of ApiResponse
655
+ object with status code, headers, etc
656
+ :type _return_http_data_only: bool, optional
657
+ :param _request_timeout: timeout setting for this request. If one
658
+ number provided, it will be total request
659
+ timeout. It can also be a pair (tuple) of
660
+ (connection, read) timeouts.
661
+ :param _request_auth: set to override the auth_settings for an a single
662
+ request; this effectively ignores the authentication
663
+ in the spec for a single request.
664
+ :type _request_auth: dict, optional
665
+ :type _content_type: string, optional: force content-type for the request
666
+ :return: Returns the result object.
667
+ If the method is called asynchronously,
668
+ returns the request thread.
669
+ :rtype: tuple(PropertyDefinitionEntity, status_code(int), headers(HTTPHeaderDict))
670
+ """
671
+
672
+ _params = locals()
673
+
674
+ _all_params = [
675
+ 'entity_unique_id',
676
+ 'effective_at',
677
+ 'as_at',
678
+ 'previews'
679
+ ]
680
+ _all_params.extend(
681
+ [
682
+ 'async_req',
683
+ '_return_http_data_only',
684
+ '_preload_content',
685
+ '_request_timeout',
686
+ '_request_auth',
687
+ '_content_type',
688
+ '_headers'
689
+ ]
690
+ )
691
+
692
+ # validate the arguments
693
+ for _key, _val in _params['kwargs'].items():
694
+ if _key not in _all_params:
695
+ raise ApiTypeError(
696
+ "Got an unexpected keyword argument '%s'"
697
+ " to method get_property_definition_by_entity_unique_id" % _key
698
+ )
699
+ _params[_key] = _val
700
+ del _params['kwargs']
701
+
702
+ _collection_formats = {}
703
+
704
+ # process the path parameters
705
+ _path_params = {}
706
+ if _params['entity_unique_id']:
707
+ _path_params['entityUniqueId'] = _params['entity_unique_id']
708
+
709
+
710
+ # process the query parameters
711
+ _query_params = []
712
+ if _params.get('effective_at') is not None: # noqa: E501
713
+ _query_params.append(('effectiveAt', _params['effective_at']))
714
+
715
+ if _params.get('as_at') is not None: # noqa: E501
716
+ if isinstance(_params['as_at'], datetime):
717
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
718
+ else:
719
+ _query_params.append(('asAt', _params['as_at']))
720
+
721
+ if _params.get('previews') is not None: # noqa: E501
722
+ _query_params.append(('previews', _params['previews']))
723
+ _collection_formats['previews'] = 'multi'
724
+
725
+ # process the header parameters
726
+ _header_params = dict(_params.get('_headers', {}))
727
+ # process the form parameters
728
+ _form_params = []
729
+ _files = {}
730
+ # process the body parameter
731
+ _body_params = None
732
+ # set the HTTP header `Accept`
733
+ _header_params['Accept'] = self.api_client.select_header_accept(
734
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
735
+
736
+ # authentication setting
737
+ _auth_settings = ['oauth2'] # noqa: E501
738
+
739
+ _response_types_map = {
740
+ '200': "PropertyDefinitionEntity",
741
+ '400': "LusidValidationProblemDetails",
742
+ }
743
+
744
+ return self.api_client.call_api(
745
+ '/api/entities/propertydefinitions/{entityUniqueId}', 'GET',
746
+ _path_params,
747
+ _query_params,
748
+ _header_params,
749
+ body=_body_params,
750
+ post_params=_form_params,
751
+ files=_files,
752
+ response_types_map=_response_types_map,
753
+ auth_settings=_auth_settings,
754
+ async_req=_params.get('async_req'),
755
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
756
+ _preload_content=_params.get('_preload_content', True),
757
+ _request_timeout=_params.get('_request_timeout'),
758
+ collection_formats=_collection_formats,
759
+ _request_auth=_params.get('_request_auth'))