lusid-sdk 2.1.322__py3-none-any.whl → 2.1.351__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 (41) hide show
  1. lusid/__init__.py +30 -0
  2. lusid/api/__init__.py +3 -1
  3. lusid/api/data_types_api.py +160 -0
  4. lusid/api/entities_api.py +172 -0
  5. lusid/api/funds_api.py +212 -0
  6. lusid/api/order_management_api.py +160 -0
  7. lusid/api/workspace_api.py +3433 -0
  8. lusid/configuration.py +16 -7
  9. lusid/models/__init__.py +28 -0
  10. lusid/models/close_period_diary_entry_request.py +1 -1
  11. lusid/models/data_type.py +8 -8
  12. lusid/models/data_type_entity.py +131 -0
  13. lusid/models/diary_entry.py +1 -1
  14. lusid/models/diary_entry_request.py +1 -1
  15. lusid/models/fund_configuration.py +6 -6
  16. lusid/models/fund_configuration_request.py +6 -6
  17. lusid/models/instrument_resolution_detail.py +19 -5
  18. lusid/models/journal_entry_line.py +5 -3
  19. lusid/models/order_update_request.py +116 -0
  20. lusid/models/paged_resource_list_of_valuation_point_overview.py +113 -0
  21. lusid/models/paged_resource_list_of_workspace.py +113 -0
  22. lusid/models/paged_resource_list_of_workspace_item.py +113 -0
  23. lusid/models/quote_access_metadata_rule_id.py +2 -2
  24. lusid/models/quote_series_id.py +2 -2
  25. lusid/models/scrip_dividend_event.py +17 -3
  26. lusid/models/share_class_breakdown.py +5 -13
  27. lusid/models/share_class_dealing_breakdown.py +96 -0
  28. lusid/models/share_class_details.py +5 -3
  29. lusid/models/stock_split_event.py +18 -4
  30. lusid/models/update_orders_response.py +153 -0
  31. lusid/models/valuation_point_data_response.py +1 -1
  32. lusid/models/valuation_point_overview.py +125 -0
  33. lusid/models/workspace.py +92 -0
  34. lusid/models/workspace_creation_request.py +78 -0
  35. lusid/models/workspace_item.py +105 -0
  36. lusid/models/workspace_item_creation_request.py +91 -0
  37. lusid/models/workspace_item_update_request.py +82 -0
  38. lusid/models/workspace_update_request.py +69 -0
  39. {lusid_sdk-2.1.322.dist-info → lusid_sdk-2.1.351.dist-info}/METADATA +39 -1
  40. {lusid_sdk-2.1.322.dist-info → lusid_sdk-2.1.351.dist-info}/RECORD +41 -26
  41. {lusid_sdk-2.1.322.dist-info → lusid_sdk-2.1.351.dist-info}/WHEEL +0 -0
lusid/__init__.py CHANGED
@@ -83,6 +83,7 @@ from lusid.api.transaction_configuration_api import TransactionConfigurationApi
83
83
  from lusid.api.transaction_fees_api import TransactionFeesApi
84
84
  from lusid.api.transaction_portfolios_api import TransactionPortfoliosApi
85
85
  from lusid.api.translation_api import TranslationApi
86
+ from lusid.api.workspace_api import WorkspaceApi
86
87
 
87
88
  # import ApiClient
88
89
  from lusid.api_client import ApiClient
@@ -333,6 +334,7 @@ from lusid.models.data_map_key import DataMapKey
333
334
  from lusid.models.data_mapping import DataMapping
334
335
  from lusid.models.data_scope import DataScope
335
336
  from lusid.models.data_type import DataType
337
+ from lusid.models.data_type_entity import DataTypeEntity
336
338
  from lusid.models.data_type_summary import DataTypeSummary
337
339
  from lusid.models.data_type_value_range import DataTypeValueRange
338
340
  from lusid.models.date_attributes import DateAttributes
@@ -630,6 +632,7 @@ from lusid.models.order_instruction_request import OrderInstructionRequest
630
632
  from lusid.models.order_instruction_set_request import OrderInstructionSetRequest
631
633
  from lusid.models.order_request import OrderRequest
632
634
  from lusid.models.order_set_request import OrderSetRequest
635
+ from lusid.models.order_update_request import OrderUpdateRequest
633
636
  from lusid.models.otc_confirmation import OtcConfirmation
634
637
  from lusid.models.output_transaction import OutputTransaction
635
638
  from lusid.models.output_transition import OutputTransition
@@ -694,7 +697,10 @@ from lusid.models.paged_resource_list_of_staging_rule_set import PagedResourceLi
694
697
  from lusid.models.paged_resource_list_of_transaction_template import PagedResourceListOfTransactionTemplate
695
698
  from lusid.models.paged_resource_list_of_transaction_template_specification import PagedResourceListOfTransactionTemplateSpecification
696
699
  from lusid.models.paged_resource_list_of_translation_script_id import PagedResourceListOfTranslationScriptId
700
+ from lusid.models.paged_resource_list_of_valuation_point_overview import PagedResourceListOfValuationPointOverview
697
701
  from lusid.models.paged_resource_list_of_virtual_row import PagedResourceListOfVirtualRow
702
+ from lusid.models.paged_resource_list_of_workspace import PagedResourceListOfWorkspace
703
+ from lusid.models.paged_resource_list_of_workspace_item import PagedResourceListOfWorkspaceItem
698
704
  from lusid.models.participation import Participation
699
705
  from lusid.models.participation_request import ParticipationRequest
700
706
  from lusid.models.participation_set_request import ParticipationSetRequest
@@ -930,6 +936,7 @@ from lusid.models.settlement_schedule import SettlementSchedule
930
936
  from lusid.models.share_class_amount import ShareClassAmount
931
937
  from lusid.models.share_class_breakdown import ShareClassBreakdown
932
938
  from lusid.models.share_class_data import ShareClassData
939
+ from lusid.models.share_class_dealing_breakdown import ShareClassDealingBreakdown
933
940
  from lusid.models.share_class_details import ShareClassDetails
934
941
  from lusid.models.share_class_pnl_breakdown import ShareClassPnlBreakdown
935
942
  from lusid.models.side_configuration_data import SideConfigurationData
@@ -1038,6 +1045,7 @@ from lusid.models.update_data_type_request import UpdateDataTypeRequest
1038
1045
  from lusid.models.update_derived_property_definition_request import UpdateDerivedPropertyDefinitionRequest
1039
1046
  from lusid.models.update_fee_type_request import UpdateFeeTypeRequest
1040
1047
  from lusid.models.update_instrument_identifier_request import UpdateInstrumentIdentifierRequest
1048
+ from lusid.models.update_orders_response import UpdateOrdersResponse
1041
1049
  from lusid.models.update_placements_response import UpdatePlacementsResponse
1042
1050
  from lusid.models.update_portfolio_group_request import UpdatePortfolioGroupRequest
1043
1051
  from lusid.models.update_portfolio_request import UpdatePortfolioRequest
@@ -1094,6 +1102,7 @@ from lusid.models.user import User
1094
1102
  from lusid.models.valuation_point_data_query_parameters import ValuationPointDataQueryParameters
1095
1103
  from lusid.models.valuation_point_data_request import ValuationPointDataRequest
1096
1104
  from lusid.models.valuation_point_data_response import ValuationPointDataResponse
1105
+ from lusid.models.valuation_point_overview import ValuationPointOverview
1097
1106
  from lusid.models.valuation_request import ValuationRequest
1098
1107
  from lusid.models.valuation_schedule import ValuationSchedule
1099
1108
  from lusid.models.valuations_reconciliation_request import ValuationsReconciliationRequest
@@ -1120,6 +1129,12 @@ from lusid.models.weekend_mask import WeekendMask
1120
1129
  from lusid.models.weighted_instrument import WeightedInstrument
1121
1130
  from lusid.models.weighted_instrument_in_line_lookup_identifiers import WeightedInstrumentInLineLookupIdentifiers
1122
1131
  from lusid.models.weighted_instruments import WeightedInstruments
1132
+ from lusid.models.workspace import Workspace
1133
+ from lusid.models.workspace_creation_request import WorkspaceCreationRequest
1134
+ from lusid.models.workspace_item import WorkspaceItem
1135
+ from lusid.models.workspace_item_creation_request import WorkspaceItemCreationRequest
1136
+ from lusid.models.workspace_item_update_request import WorkspaceItemUpdateRequest
1137
+ from lusid.models.workspace_update_request import WorkspaceUpdateRequest
1123
1138
  from lusid.models.yield_curve_data import YieldCurveData
1124
1139
 
1125
1140
  # import extensions into sdk package
@@ -1202,6 +1217,7 @@ __all__ = [
1202
1217
  "TransactionFeesApi",
1203
1218
  "TransactionPortfoliosApi",
1204
1219
  "TranslationApi",
1220
+ "WorkspaceApi",
1205
1221
  "A2BBreakdown",
1206
1222
  "A2BCategory",
1207
1223
  "A2BDataRecord",
@@ -1442,6 +1458,7 @@ __all__ = [
1442
1458
  "DataMapping",
1443
1459
  "DataScope",
1444
1460
  "DataType",
1461
+ "DataTypeEntity",
1445
1462
  "DataTypeSummary",
1446
1463
  "DataTypeValueRange",
1447
1464
  "DateAttributes",
@@ -1739,6 +1756,7 @@ __all__ = [
1739
1756
  "OrderInstructionSetRequest",
1740
1757
  "OrderRequest",
1741
1758
  "OrderSetRequest",
1759
+ "OrderUpdateRequest",
1742
1760
  "OtcConfirmation",
1743
1761
  "OutputTransaction",
1744
1762
  "OutputTransition",
@@ -1803,7 +1821,10 @@ __all__ = [
1803
1821
  "PagedResourceListOfTransactionTemplate",
1804
1822
  "PagedResourceListOfTransactionTemplateSpecification",
1805
1823
  "PagedResourceListOfTranslationScriptId",
1824
+ "PagedResourceListOfValuationPointOverview",
1806
1825
  "PagedResourceListOfVirtualRow",
1826
+ "PagedResourceListOfWorkspace",
1827
+ "PagedResourceListOfWorkspaceItem",
1807
1828
  "Participation",
1808
1829
  "ParticipationRequest",
1809
1830
  "ParticipationSetRequest",
@@ -2039,6 +2060,7 @@ __all__ = [
2039
2060
  "ShareClassAmount",
2040
2061
  "ShareClassBreakdown",
2041
2062
  "ShareClassData",
2063
+ "ShareClassDealingBreakdown",
2042
2064
  "ShareClassDetails",
2043
2065
  "ShareClassPnlBreakdown",
2044
2066
  "SideConfigurationData",
@@ -2147,6 +2169,7 @@ __all__ = [
2147
2169
  "UpdateDerivedPropertyDefinitionRequest",
2148
2170
  "UpdateFeeTypeRequest",
2149
2171
  "UpdateInstrumentIdentifierRequest",
2172
+ "UpdateOrdersResponse",
2150
2173
  "UpdatePlacementsResponse",
2151
2174
  "UpdatePortfolioGroupRequest",
2152
2175
  "UpdatePortfolioRequest",
@@ -2203,6 +2226,7 @@ __all__ = [
2203
2226
  "ValuationPointDataQueryParameters",
2204
2227
  "ValuationPointDataRequest",
2205
2228
  "ValuationPointDataResponse",
2229
+ "ValuationPointOverview",
2206
2230
  "ValuationRequest",
2207
2231
  "ValuationSchedule",
2208
2232
  "ValuationsReconciliationRequest",
@@ -2229,6 +2253,12 @@ __all__ = [
2229
2253
  "WeightedInstrument",
2230
2254
  "WeightedInstrumentInLineLookupIdentifiers",
2231
2255
  "WeightedInstruments",
2256
+ "Workspace",
2257
+ "WorkspaceCreationRequest",
2258
+ "WorkspaceItem",
2259
+ "WorkspaceItemCreationRequest",
2260
+ "WorkspaceItemUpdateRequest",
2261
+ "WorkspaceUpdateRequest",
2232
2262
  "YieldCurveData",
2233
2263
  "ApiClient",
2234
2264
  "Configuration",
lusid/api/__init__.py CHANGED
@@ -67,6 +67,7 @@ from lusid.api.transaction_configuration_api import TransactionConfigurationApi
67
67
  from lusid.api.transaction_fees_api import TransactionFeesApi
68
68
  from lusid.api.transaction_portfolios_api import TransactionPortfoliosApi
69
69
  from lusid.api.translation_api import TranslationApi
70
+ from lusid.api.workspace_api import WorkspaceApi
70
71
 
71
72
 
72
73
  __all__ = [
@@ -135,5 +136,6 @@ __all__ = [
135
136
  "TransactionConfigurationApi",
136
137
  "TransactionFeesApi",
137
138
  "TransactionPortfoliosApi",
138
- "TranslationApi"
139
+ "TranslationApi",
140
+ "WorkspaceApi"
139
141
  ]
@@ -28,6 +28,7 @@ from typing import Optional
28
28
 
29
29
  from lusid.models.create_data_type_request import CreateDataTypeRequest
30
30
  from lusid.models.data_type import DataType
31
+ from lusid.models.deleted_entity_response import DeletedEntityResponse
31
32
  from lusid.models.field_value import FieldValue
32
33
  from lusid.models.paged_resource_list_of_data_type_summary import PagedResourceListOfDataTypeSummary
33
34
  from lusid.models.resource_list_of_data_type import ResourceListOfDataType
@@ -212,6 +213,165 @@ class DataTypesApi:
212
213
  collection_formats=_collection_formats,
213
214
  _request_auth=_params.get('_request_auth'))
214
215
 
216
+ @overload
217
+ async def delete_data_type(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the data type")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the data type")], **kwargs) -> DeletedEntityResponse: # noqa: E501
218
+ ...
219
+
220
+ @overload
221
+ def delete_data_type(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the data type")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the data type")], async_req: Optional[bool]=True, **kwargs) -> DeletedEntityResponse: # noqa: E501
222
+ ...
223
+
224
+ @validate_arguments
225
+ def delete_data_type(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the data type")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the data type")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
226
+ """DeleteDataType: Delete a data type definition. # noqa: E501
227
+
228
+ Delete an existing data type definition. Data types cannot be deleted in either the \"default\" or \"system\" scopes, scopes beginning with \"LUSID-\", or data types that are in use on a property definition. # noqa: E501
229
+ This method makes a synchronous HTTP request by default. To make an
230
+ asynchronous HTTP request, please pass async_req=True
231
+
232
+ >>> thread = api.delete_data_type(scope, code, async_req=True)
233
+ >>> result = thread.get()
234
+
235
+ :param scope: The scope of the data type (required)
236
+ :type scope: str
237
+ :param code: The code of the data type (required)
238
+ :type code: str
239
+ :param async_req: Whether to execute the request asynchronously.
240
+ :type async_req: bool, optional
241
+ :param _request_timeout: timeout setting for this request.
242
+ If one number provided, it will be total request
243
+ timeout. It can also be a pair (tuple) of
244
+ (connection, read) timeouts.
245
+ :return: Returns the result object.
246
+ If the method is called asynchronously,
247
+ returns the request thread.
248
+ :rtype: DeletedEntityResponse
249
+ """
250
+ kwargs['_return_http_data_only'] = True
251
+ if '_preload_content' in kwargs:
252
+ message = "Error! Please call the delete_data_type_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
253
+ raise ValueError(message)
254
+ if async_req is not None:
255
+ kwargs['async_req'] = async_req
256
+ return self.delete_data_type_with_http_info(scope, code, **kwargs) # noqa: E501
257
+
258
+ @validate_arguments
259
+ def delete_data_type_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the data type")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the data type")], **kwargs) -> ApiResponse: # noqa: E501
260
+ """DeleteDataType: Delete a data type definition. # noqa: E501
261
+
262
+ Delete an existing data type definition. Data types cannot be deleted in either the \"default\" or \"system\" scopes, scopes beginning with \"LUSID-\", or data types that are in use on a property definition. # noqa: E501
263
+ This method makes a synchronous HTTP request by default. To make an
264
+ asynchronous HTTP request, please pass async_req=True
265
+
266
+ >>> thread = api.delete_data_type_with_http_info(scope, code, async_req=True)
267
+ >>> result = thread.get()
268
+
269
+ :param scope: The scope of the data type (required)
270
+ :type scope: str
271
+ :param code: The code of the data type (required)
272
+ :type code: str
273
+ :param async_req: Whether to execute the request asynchronously.
274
+ :type async_req: bool, optional
275
+ :param _preload_content: if False, the ApiResponse.data will
276
+ be set to none and raw_data will store the
277
+ HTTP response body without reading/decoding.
278
+ Default is True.
279
+ :type _preload_content: bool, optional
280
+ :param _return_http_data_only: response data instead of ApiResponse
281
+ object with status code, headers, etc
282
+ :type _return_http_data_only: bool, optional
283
+ :param _request_timeout: timeout setting for this request. If one
284
+ number provided, it will be total request
285
+ timeout. It can also be a pair (tuple) of
286
+ (connection, read) timeouts.
287
+ :param _request_auth: set to override the auth_settings for an a single
288
+ request; this effectively ignores the authentication
289
+ in the spec for a single request.
290
+ :type _request_auth: dict, optional
291
+ :type _content_type: string, optional: force content-type for the request
292
+ :return: Returns the result object.
293
+ If the method is called asynchronously,
294
+ returns the request thread.
295
+ :rtype: tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))
296
+ """
297
+
298
+ _params = locals()
299
+
300
+ _all_params = [
301
+ 'scope',
302
+ 'code'
303
+ ]
304
+ _all_params.extend(
305
+ [
306
+ 'async_req',
307
+ '_return_http_data_only',
308
+ '_preload_content',
309
+ '_request_timeout',
310
+ '_request_auth',
311
+ '_content_type',
312
+ '_headers'
313
+ ]
314
+ )
315
+
316
+ # validate the arguments
317
+ for _key, _val in _params['kwargs'].items():
318
+ if _key not in _all_params:
319
+ raise ApiTypeError(
320
+ "Got an unexpected keyword argument '%s'"
321
+ " to method delete_data_type" % _key
322
+ )
323
+ _params[_key] = _val
324
+ del _params['kwargs']
325
+
326
+ _collection_formats = {}
327
+
328
+ # process the path parameters
329
+ _path_params = {}
330
+ if _params['scope']:
331
+ _path_params['scope'] = _params['scope']
332
+
333
+ if _params['code']:
334
+ _path_params['code'] = _params['code']
335
+
336
+
337
+ # process the query parameters
338
+ _query_params = []
339
+ # process the header parameters
340
+ _header_params = dict(_params.get('_headers', {}))
341
+ # process the form parameters
342
+ _form_params = []
343
+ _files = {}
344
+ # process the body parameter
345
+ _body_params = None
346
+ # set the HTTP header `Accept`
347
+ _header_params['Accept'] = self.api_client.select_header_accept(
348
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
349
+
350
+ # authentication setting
351
+ _auth_settings = ['oauth2'] # noqa: E501
352
+
353
+ _response_types_map = {
354
+ '200': "DeletedEntityResponse",
355
+ '400': "LusidValidationProblemDetails",
356
+ }
357
+
358
+ return self.api_client.call_api(
359
+ '/api/datatypes/{scope}/{code}', 'DELETE',
360
+ _path_params,
361
+ _query_params,
362
+ _header_params,
363
+ body=_body_params,
364
+ post_params=_form_params,
365
+ files=_files,
366
+ response_types_map=_response_types_map,
367
+ auth_settings=_auth_settings,
368
+ async_req=_params.get('async_req'),
369
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
370
+ _preload_content=_params.get('_preload_content', True),
371
+ _request_timeout=_params.get('_request_timeout'),
372
+ collection_formats=_collection_formats,
373
+ _request_auth=_params.get('_request_auth'))
374
+
215
375
  @overload
216
376
  async def get_data_type(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the data type")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the data type")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.")] = None, **kwargs) -> DataType: # noqa: E501
217
377
  ...
lusid/api/entities_api.py CHANGED
@@ -26,6 +26,7 @@ from pydantic.v1 import Field, StrictStr, conlist, constr, validator
26
26
 
27
27
  from typing import Optional
28
28
 
29
+ from lusid.models.data_type_entity import DataTypeEntity
29
30
  from lusid.models.instrument_entity import InstrumentEntity
30
31
  from lusid.models.portfolio_entity import PortfolioEntity
31
32
  from lusid.models.property_definition_entity import PropertyDefinitionEntity
@@ -51,6 +52,177 @@ class EntitiesApi:
51
52
  api_client = ApiClient.get_default()
52
53
  self.api_client = api_client
53
54
 
55
+ @overload
56
+ 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
+ ...
58
+
59
+ @overload
60
+ 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, async_req: Optional[bool]=True, **kwargs) -> DataTypeEntity: # noqa: E501
61
+ ...
62
+
63
+ @validate_arguments
64
+ 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, async_req: Optional[bool]=None, **kwargs) -> Union[DataTypeEntity, Awaitable[DataTypeEntity]]: # noqa: E501
65
+ """[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
66
+
67
+ Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. # noqa: E501
68
+ This method makes a synchronous HTTP request by default. To make an
69
+ asynchronous HTTP request, please pass async_req=True
70
+
71
+ >>> thread = api.get_data_type_by_entity_unique_id(entity_unique_id, as_at, previews, async_req=True)
72
+ >>> result = thread.get()
73
+
74
+ :param entity_unique_id: The universally unique identifier of the DataType definition. (required)
75
+ :type entity_unique_id: str
76
+ :param as_at: The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.
77
+ :type as_at: datetime
78
+ :param previews: The ids of the staged modifications to be previewed in the response.
79
+ :type previews: List[str]
80
+ :param async_req: Whether to execute the request asynchronously.
81
+ :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.
86
+ :return: Returns the result object.
87
+ If the method is called asynchronously,
88
+ returns the request thread.
89
+ :rtype: DataTypeEntity
90
+ """
91
+ kwargs['_return_http_data_only'] = True
92
+ if '_preload_content' in kwargs:
93
+ message = "Error! Please call the get_data_type_by_entity_unique_id_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
94
+ raise ValueError(message)
95
+ if async_req is not None:
96
+ kwargs['async_req'] = async_req
97
+ return self.get_data_type_by_entity_unique_id_with_http_info(entity_unique_id, as_at, previews, **kwargs) # noqa: E501
98
+
99
+ @validate_arguments
100
+ def get_data_type_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 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) -> ApiResponse: # noqa: E501
101
+ """[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
102
+
103
+ Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to deletion. # noqa: E501
104
+ This method makes a synchronous HTTP request by default. To make an
105
+ asynchronous HTTP request, please pass async_req=True
106
+
107
+ >>> thread = api.get_data_type_by_entity_unique_id_with_http_info(entity_unique_id, as_at, previews, async_req=True)
108
+ >>> result = thread.get()
109
+
110
+ :param entity_unique_id: The universally unique identifier of the DataType definition. (required)
111
+ :type entity_unique_id: str
112
+ :param as_at: The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.
113
+ :type as_at: datetime
114
+ :param previews: The ids of the staged modifications to be previewed in the response.
115
+ :type previews: List[str]
116
+ :param async_req: Whether to execute the request asynchronously.
117
+ :type async_req: bool, optional
118
+ :param _preload_content: if False, the ApiResponse.data will
119
+ be set to none and raw_data will store the
120
+ HTTP response body without reading/decoding.
121
+ Default is True.
122
+ :type _preload_content: bool, optional
123
+ :param _return_http_data_only: response data instead of ApiResponse
124
+ object with status code, headers, etc
125
+ :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.
130
+ :param _request_auth: set to override the auth_settings for an a single
131
+ request; this effectively ignores the authentication
132
+ in the spec for a single request.
133
+ :type _request_auth: dict, optional
134
+ :type _content_type: string, optional: force content-type for the request
135
+ :return: Returns the result object.
136
+ If the method is called asynchronously,
137
+ returns the request thread.
138
+ :rtype: tuple(DataTypeEntity, status_code(int), headers(HTTPHeaderDict))
139
+ """
140
+
141
+ _params = locals()
142
+
143
+ _all_params = [
144
+ 'entity_unique_id',
145
+ 'as_at',
146
+ 'previews'
147
+ ]
148
+ _all_params.extend(
149
+ [
150
+ 'async_req',
151
+ '_return_http_data_only',
152
+ '_preload_content',
153
+ '_request_timeout',
154
+ '_request_auth',
155
+ '_content_type',
156
+ '_headers'
157
+ ]
158
+ )
159
+
160
+ # validate the arguments
161
+ for _key, _val in _params['kwargs'].items():
162
+ if _key not in _all_params:
163
+ raise ApiTypeError(
164
+ "Got an unexpected keyword argument '%s'"
165
+ " to method get_data_type_by_entity_unique_id" % _key
166
+ )
167
+ _params[_key] = _val
168
+ del _params['kwargs']
169
+
170
+ _collection_formats = {}
171
+
172
+ # process the path parameters
173
+ _path_params = {}
174
+ if _params['entity_unique_id']:
175
+ _path_params['entityUniqueId'] = _params['entity_unique_id']
176
+
177
+
178
+ # process the query parameters
179
+ _query_params = []
180
+ if _params.get('as_at') is not None: # noqa: E501
181
+ if isinstance(_params['as_at'], datetime):
182
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
183
+ else:
184
+ _query_params.append(('asAt', _params['as_at']))
185
+
186
+ if _params.get('previews') is not None: # noqa: E501
187
+ _query_params.append(('previews', _params['previews']))
188
+ _collection_formats['previews'] = 'multi'
189
+
190
+ # process the header parameters
191
+ _header_params = dict(_params.get('_headers', {}))
192
+ # process the form parameters
193
+ _form_params = []
194
+ _files = {}
195
+ # process the body parameter
196
+ _body_params = None
197
+ # set the HTTP header `Accept`
198
+ _header_params['Accept'] = self.api_client.select_header_accept(
199
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
200
+
201
+ # authentication setting
202
+ _auth_settings = ['oauth2'] # noqa: E501
203
+
204
+ _response_types_map = {
205
+ '200': "DataTypeEntity",
206
+ '400': "LusidValidationProblemDetails",
207
+ }
208
+
209
+ return self.api_client.call_api(
210
+ '/api/entities/datatypes/{entityUniqueId}', 'GET',
211
+ _path_params,
212
+ _query_params,
213
+ _header_params,
214
+ body=_body_params,
215
+ post_params=_form_params,
216
+ files=_files,
217
+ response_types_map=_response_types_map,
218
+ auth_settings=_auth_settings,
219
+ async_req=_params.get('async_req'),
220
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
221
+ _preload_content=_params.get('_preload_content', True),
222
+ _request_timeout=_params.get('_request_timeout'),
223
+ collection_formats=_collection_formats,
224
+ _request_auth=_params.get('_request_auth'))
225
+
54
226
  @overload
55
227
  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
228
  ...