lusid-sdk 2.1.630__py3-none-any.whl → 2.1.632__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.
lusid/__init__.py CHANGED
@@ -70,7 +70,6 @@ from lusid.api.relation_definitions_api import RelationDefinitionsApi
70
70
  from lusid.api.relations_api import RelationsApi
71
71
  from lusid.api.relationship_definitions_api import RelationshipDefinitionsApi
72
72
  from lusid.api.relationships_api import RelationshipsApi
73
- from lusid.api.risk_model_factor_sets_api import RiskModelFactorSetsApi
74
73
  from lusid.api.schemas_api import SchemasApi
75
74
  from lusid.api.scopes_api import ScopesApi
76
75
  from lusid.api.scripted_translation_api import ScriptedTranslationApi
@@ -248,6 +247,7 @@ from lusid.models.cleardown_module_rules_updated_response import CleardownModule
248
247
  from lusid.models.client import Client
249
248
  from lusid.models.close_event import CloseEvent
250
249
  from lusid.models.close_period_diary_entry_request import ClosePeriodDiaryEntryRequest
250
+ from lusid.models.closed_period import ClosedPeriod
251
251
  from lusid.models.comparison_attribute_value_pair import ComparisonAttributeValuePair
252
252
  from lusid.models.complete_portfolio import CompletePortfolio
253
253
  from lusid.models.complete_relation import CompleteRelation
@@ -310,6 +310,7 @@ from lusid.models.counterparty_signatory import CounterpartySignatory
310
310
  from lusid.models.create_address_key_definition_request import CreateAddressKeyDefinitionRequest
311
311
  from lusid.models.create_amortisation_rule_set_request import CreateAmortisationRuleSetRequest
312
312
  from lusid.models.create_calendar_request import CreateCalendarRequest
313
+ from lusid.models.create_closed_period_request import CreateClosedPeriodRequest
313
314
  from lusid.models.create_compliance_template_request import CreateComplianceTemplateRequest
314
315
  from lusid.models.create_corporate_action_source_request import CreateCorporateActionSourceRequest
315
316
  from lusid.models.create_custom_entity_type_request import CreateCustomEntityTypeRequest
@@ -331,7 +332,6 @@ from lusid.models.create_relation_definition_request import CreateRelationDefini
331
332
  from lusid.models.create_relation_request import CreateRelationRequest
332
333
  from lusid.models.create_relationship_definition_request import CreateRelationshipDefinitionRequest
333
334
  from lusid.models.create_relationship_request import CreateRelationshipRequest
334
- from lusid.models.create_risk_model_factor_set_request import CreateRiskModelFactorSetRequest
335
335
  from lusid.models.create_sequence_request import CreateSequenceRequest
336
336
  from lusid.models.create_staging_rule_set_request import CreateStagingRuleSetRequest
337
337
  from lusid.models.create_tax_rule_set_request import CreateTaxRuleSetRequest
@@ -783,7 +783,6 @@ from lusid.models.paged_resource_list_of_property_definition_search_result impor
783
783
  from lusid.models.paged_resource_list_of_reconciliation import PagedResourceListOfReconciliation
784
784
  from lusid.models.paged_resource_list_of_reference_list_response import PagedResourceListOfReferenceListResponse
785
785
  from lusid.models.paged_resource_list_of_relationship_definition import PagedResourceListOfRelationshipDefinition
786
- from lusid.models.paged_resource_list_of_risk_model_factor_set import PagedResourceListOfRiskModelFactorSet
787
786
  from lusid.models.paged_resource_list_of_sequence_definition import PagedResourceListOfSequenceDefinition
788
787
  from lusid.models.paged_resource_list_of_staged_modification import PagedResourceListOfStagedModification
789
788
  from lusid.models.paged_resource_list_of_staged_modifications_requested_change_interval import PagedResourceListOfStagedModificationsRequestedChangeInterval
@@ -1012,7 +1011,6 @@ from lusid.models.result_value_string import ResultValueString
1012
1011
  from lusid.models.result_value_type import ResultValueType
1013
1012
  from lusid.models.return_zero_pv_options import ReturnZeroPvOptions
1014
1013
  from lusid.models.reverse_stock_split_event import ReverseStockSplitEvent
1015
- from lusid.models.risk_model_factor_set import RiskModelFactorSet
1016
1014
  from lusid.models.rounding_configuration import RoundingConfiguration
1017
1015
  from lusid.models.rounding_configuration_component import RoundingConfigurationComponent
1018
1016
  from lusid.models.rounding_convention import RoundingConvention
@@ -1171,7 +1169,6 @@ from lusid.models.update_property_definition_request import UpdatePropertyDefini
1171
1169
  from lusid.models.update_reconciliation_request import UpdateReconciliationRequest
1172
1170
  from lusid.models.update_reference_data_request import UpdateReferenceDataRequest
1173
1171
  from lusid.models.update_relationship_definition_request import UpdateRelationshipDefinitionRequest
1174
- from lusid.models.update_risk_model_factor_set_request import UpdateRiskModelFactorSetRequest
1175
1172
  from lusid.models.update_staging_rule_set_request import UpdateStagingRuleSetRequest
1176
1173
  from lusid.models.update_tax_rule_set_request import UpdateTaxRuleSetRequest
1177
1174
  from lusid.models.update_timeline_request import UpdateTimelineRequest
@@ -1331,7 +1328,6 @@ __all__ = [
1331
1328
  "RelationsApi",
1332
1329
  "RelationshipDefinitionsApi",
1333
1330
  "RelationshipsApi",
1334
- "RiskModelFactorSetsApi",
1335
1331
  "SchemasApi",
1336
1332
  "ScopesApi",
1337
1333
  "ScriptedTranslationApi",
@@ -1499,6 +1495,7 @@ __all__ = [
1499
1495
  "Client",
1500
1496
  "CloseEvent",
1501
1497
  "ClosePeriodDiaryEntryRequest",
1498
+ "ClosedPeriod",
1502
1499
  "ComparisonAttributeValuePair",
1503
1500
  "CompletePortfolio",
1504
1501
  "CompleteRelation",
@@ -1561,6 +1558,7 @@ __all__ = [
1561
1558
  "CreateAddressKeyDefinitionRequest",
1562
1559
  "CreateAmortisationRuleSetRequest",
1563
1560
  "CreateCalendarRequest",
1561
+ "CreateClosedPeriodRequest",
1564
1562
  "CreateComplianceTemplateRequest",
1565
1563
  "CreateCorporateActionSourceRequest",
1566
1564
  "CreateCustomEntityTypeRequest",
@@ -1582,7 +1580,6 @@ __all__ = [
1582
1580
  "CreateRelationRequest",
1583
1581
  "CreateRelationshipDefinitionRequest",
1584
1582
  "CreateRelationshipRequest",
1585
- "CreateRiskModelFactorSetRequest",
1586
1583
  "CreateSequenceRequest",
1587
1584
  "CreateStagingRuleSetRequest",
1588
1585
  "CreateTaxRuleSetRequest",
@@ -2034,7 +2031,6 @@ __all__ = [
2034
2031
  "PagedResourceListOfReconciliation",
2035
2032
  "PagedResourceListOfReferenceListResponse",
2036
2033
  "PagedResourceListOfRelationshipDefinition",
2037
- "PagedResourceListOfRiskModelFactorSet",
2038
2034
  "PagedResourceListOfSequenceDefinition",
2039
2035
  "PagedResourceListOfStagedModification",
2040
2036
  "PagedResourceListOfStagedModificationsRequestedChangeInterval",
@@ -2263,7 +2259,6 @@ __all__ = [
2263
2259
  "ResultValueType",
2264
2260
  "ReturnZeroPvOptions",
2265
2261
  "ReverseStockSplitEvent",
2266
- "RiskModelFactorSet",
2267
2262
  "RoundingConfiguration",
2268
2263
  "RoundingConfigurationComponent",
2269
2264
  "RoundingConvention",
@@ -2422,7 +2417,6 @@ __all__ = [
2422
2417
  "UpdateReconciliationRequest",
2423
2418
  "UpdateReferenceDataRequest",
2424
2419
  "UpdateRelationshipDefinitionRequest",
2425
- "UpdateRiskModelFactorSetRequest",
2426
2420
  "UpdateStagingRuleSetRequest",
2427
2421
  "UpdateTaxRuleSetRequest",
2428
2422
  "UpdateTimelineRequest",
lusid/api/__init__.py CHANGED
@@ -54,7 +54,6 @@ from lusid.api.relation_definitions_api import RelationDefinitionsApi
54
54
  from lusid.api.relations_api import RelationsApi
55
55
  from lusid.api.relationship_definitions_api import RelationshipDefinitionsApi
56
56
  from lusid.api.relationships_api import RelationshipsApi
57
- from lusid.api.risk_model_factor_sets_api import RiskModelFactorSetsApi
58
57
  from lusid.api.schemas_api import SchemasApi
59
58
  from lusid.api.scopes_api import ScopesApi
60
59
  from lusid.api.scripted_translation_api import ScriptedTranslationApi
@@ -127,7 +126,6 @@ __all__ = [
127
126
  "RelationsApi",
128
127
  "RelationshipDefinitionsApi",
129
128
  "RelationshipsApi",
130
- "RiskModelFactorSetsApi",
131
129
  "SchemasApi",
132
130
  "ScopesApi",
133
131
  "ScriptedTranslationApi",
@@ -400,7 +400,7 @@ class CorporateActionSourcesApi:
400
400
 
401
401
  @validate_arguments
402
402
  def delete_corporate_action_source(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source to be deleted")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source to be deleted")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
403
- """[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
403
+ """[BETA] DeleteCorporateActionSource: Delete a corporate action source # noqa: E501
404
404
 
405
405
  Deletes a single corporate action source # noqa: E501
406
406
  This method makes a synchronous HTTP request by default. To make an
@@ -433,7 +433,7 @@ class CorporateActionSourcesApi:
433
433
 
434
434
  @validate_arguments
435
435
  def delete_corporate_action_source_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source to be deleted")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source to be deleted")], **kwargs) -> ApiResponse: # noqa: E501
436
- """[BETA] DeleteCorporateActionSource: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
436
+ """[BETA] DeleteCorporateActionSource: Delete a corporate action source # noqa: E501
437
437
 
438
438
  Deletes a single corporate action source # noqa: E501
439
439
  This method makes a synchronous HTTP request by default. To make an
@@ -559,7 +559,7 @@ class CorporateActionSourcesApi:
559
559
 
560
560
  @validate_arguments
561
561
  def delete_corporate_actions(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source")], corporate_action_ids : Annotated[conlist(StrictStr, max_items=1000), Field(..., description="The IDs of the corporate actions to delete")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
562
- """[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
562
+ """[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions (instrument transition events) from a corporate action source # noqa: E501
563
563
 
564
564
  Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. # noqa: E501
565
565
  This method makes a synchronous HTTP request by default. To make an
@@ -594,7 +594,7 @@ class CorporateActionSourcesApi:
594
594
 
595
595
  @validate_arguments
596
596
  def delete_corporate_actions_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source")], corporate_action_ids : Annotated[conlist(StrictStr, max_items=1000), Field(..., description="The IDs of the corporate actions to delete")], **kwargs) -> ApiResponse: # noqa: E501
597
- """[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions # noqa: E501
597
+ """[EARLY ACCESS] DeleteCorporateActions: Delete corporate actions (instrument transition events) from a corporate action source # noqa: E501
598
598
 
599
599
  Delete one or more corporate actions from a particular corporate action source. The maximum number of corporate actions that this method can delete per request is 1,000. # noqa: E501
600
600
  This method makes a synchronous HTTP request by default. To make an
@@ -727,7 +727,7 @@ class CorporateActionSourcesApi:
727
727
 
728
728
  @validate_arguments
729
729
  def delete_instrument_events(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source")], instrument_event_ids : Annotated[conlist(StrictStr, max_items=1000), Field(..., description="The IDs of the instrument events to delete")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
730
- """[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
730
+ """[EARLY ACCESS] DeleteInstrumentEvents: Delete instrument events from a corporate action source # noqa: E501
731
731
 
732
732
  Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. # noqa: E501
733
733
  This method makes a synchronous HTTP request by default. To make an
@@ -762,7 +762,7 @@ class CorporateActionSourcesApi:
762
762
 
763
763
  @validate_arguments
764
764
  def delete_instrument_events_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the corporate action source")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the corporate action source")], instrument_event_ids : Annotated[conlist(StrictStr, max_items=1000), Field(..., description="The IDs of the instrument events to delete")], **kwargs) -> ApiResponse: # noqa: E501
765
- """[EARLY ACCESS] DeleteInstrumentEvents: Delete corporate actions (instrument transition events) from the corporate action source. # noqa: E501
765
+ """[EARLY ACCESS] DeleteInstrumentEvents: Delete instrument events from a corporate action source # noqa: E501
766
766
 
767
767
  Delete one or more corporate actions from a particular corporate action source. The maximum number of instrument events that this method can delete per request is 1,000. # noqa: E501
768
768
  This method makes a synchronous HTTP request by default. To make an
@@ -26,6 +26,8 @@ from pydantic.v1 import Field, StrictStr, conlist, constr, validator
26
26
 
27
27
  from typing import Optional
28
28
 
29
+ from lusid.models.closed_period import ClosedPeriod
30
+ from lusid.models.create_closed_period_request import CreateClosedPeriodRequest
29
31
  from lusid.models.create_timeline_request import CreateTimelineRequest
30
32
  from lusid.models.deleted_entity_response import DeletedEntityResponse
31
33
  from lusid.models.timeline import Timeline
@@ -52,6 +54,180 @@ class TimelinesApi:
52
54
  api_client = ApiClient.get_default()
53
55
  self.api_client = api_client
54
56
 
57
+ @overload
58
+ async def create_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
59
+ ...
60
+
61
+ @overload
62
+ def create_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
63
+ ...
64
+
65
+ @validate_arguments
66
+ def create_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
67
+ """[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
68
+
69
+ Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # noqa: E501
70
+ This method makes a synchronous HTTP request by default. To make an
71
+ asynchronous HTTP request, please pass async_req=True
72
+
73
+ >>> thread = api.create_closed_period(scope, code, create_closed_period_request, async_req=True)
74
+ >>> result = thread.get()
75
+
76
+ :param scope: The scope of the specified Timeline. (required)
77
+ :type scope: str
78
+ :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
79
+ :type code: str
80
+ :param create_closed_period_request: The request containing the details of the Closed Period
81
+ :type create_closed_period_request: CreateClosedPeriodRequest
82
+ :param async_req: Whether to execute the request asynchronously.
83
+ :type async_req: bool, optional
84
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
85
+ :param opts: Configuration options for this request
86
+ :type opts: ConfigurationOptions, optional
87
+ :return: Returns the result object.
88
+ If the method is called asynchronously,
89
+ returns the request thread.
90
+ :rtype: ClosedPeriod
91
+ """
92
+ kwargs['_return_http_data_only'] = True
93
+ if '_preload_content' in kwargs:
94
+ message = "Error! Please call the create_closed_period_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.create_closed_period_with_http_info(scope, code, create_closed_period_request, **kwargs) # noqa: E501
99
+
100
+ @validate_arguments
101
+ def create_closed_period_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.")], create_closed_period_request : Annotated[Optional[CreateClosedPeriodRequest], Field(description="The request containing the details of the Closed Period")] = None, **kwargs) -> ApiResponse: # noqa: E501
102
+ """[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity # noqa: E501
103
+
104
+ Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties # 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.create_closed_period_with_http_info(scope, code, create_closed_period_request, async_req=True)
109
+ >>> result = thread.get()
110
+
111
+ :param scope: The scope of the specified Timeline. (required)
112
+ :type scope: str
113
+ :param code: The code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline. (required)
114
+ :type code: str
115
+ :param create_closed_period_request: The request containing the details of the Closed Period
116
+ :type create_closed_period_request: CreateClosedPeriodRequest
117
+ :param async_req: Whether to execute the request asynchronously.
118
+ :type async_req: bool, optional
119
+ :param _preload_content: if False, the ApiResponse.data will
120
+ be set to none and raw_data will store the
121
+ HTTP response body without reading/decoding.
122
+ Default is True.
123
+ :type _preload_content: bool, optional
124
+ :param _return_http_data_only: response data instead of ApiResponse
125
+ object with status code, headers, etc
126
+ :type _return_http_data_only: bool, optional
127
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
128
+ :param opts: Configuration options for this request
129
+ :type opts: ConfigurationOptions, optional
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(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))
139
+ """
140
+
141
+ _params = locals()
142
+
143
+ _all_params = [
144
+ 'scope',
145
+ 'code',
146
+ 'create_closed_period_request'
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
+ 'opts'
158
+ ]
159
+ )
160
+
161
+ # validate the arguments
162
+ for _key, _val in _params['kwargs'].items():
163
+ if _key not in _all_params:
164
+ raise ApiTypeError(
165
+ "Got an unexpected keyword argument '%s'"
166
+ " to method create_closed_period" % _key
167
+ )
168
+ _params[_key] = _val
169
+ del _params['kwargs']
170
+
171
+ _collection_formats = {}
172
+
173
+ # process the path parameters
174
+ _path_params = {}
175
+ if _params['scope']:
176
+ _path_params['scope'] = _params['scope']
177
+
178
+ if _params['code']:
179
+ _path_params['code'] = _params['code']
180
+
181
+
182
+ # process the query parameters
183
+ _query_params = []
184
+ # process the header parameters
185
+ _header_params = dict(_params.get('_headers', {}))
186
+ # process the form parameters
187
+ _form_params = []
188
+ _files = {}
189
+ # process the body parameter
190
+ _body_params = None
191
+ if _params['create_closed_period_request'] is not None:
192
+ _body_params = _params['create_closed_period_request']
193
+
194
+ # set the HTTP header `Accept`
195
+ _header_params['Accept'] = self.api_client.select_header_accept(
196
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
197
+
198
+ # set the HTTP header `Content-Type`
199
+ _content_types_list = _params.get('_content_type',
200
+ self.api_client.select_header_content_type(
201
+ ['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
202
+ if _content_types_list:
203
+ _header_params['Content-Type'] = _content_types_list
204
+
205
+ # authentication setting
206
+ _auth_settings = ['oauth2'] # noqa: E501
207
+
208
+ _response_types_map = {
209
+ '201': "ClosedPeriod",
210
+ '400': "LusidValidationProblemDetails",
211
+ }
212
+
213
+ return self.api_client.call_api(
214
+ '/api/timelines/{scope}/{code}/closedperiods', 'POST',
215
+ _path_params,
216
+ _query_params,
217
+ _header_params,
218
+ body=_body_params,
219
+ post_params=_form_params,
220
+ files=_files,
221
+ response_types_map=_response_types_map,
222
+ auth_settings=_auth_settings,
223
+ async_req=_params.get('async_req'),
224
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
225
+ _preload_content=_params.get('_preload_content', True),
226
+ _request_timeout=_params.get('_request_timeout'),
227
+ opts=_params.get('opts'),
228
+ collection_formats=_collection_formats,
229
+ _request_auth=_params.get('_request_auth'))
230
+
55
231
  @overload
56
232
  async def create_timeline(self, create_timeline_request : Annotated[Optional[CreateTimelineRequest], Field(description="The request containing the details of the Timeline")] = None, **kwargs) -> Timeline: # noqa: E501
57
233
  ...
@@ -369,6 +545,193 @@ class TimelinesApi:
369
545
  collection_formats=_collection_formats,
370
546
  _request_auth=_params.get('_request_auth'))
371
547
 
548
+ @overload
549
+ async def get_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ClosedPeriod: # noqa: E501
550
+ ...
551
+
552
+ @overload
553
+ def get_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=True, **kwargs) -> ClosedPeriod: # noqa: E501
554
+ ...
555
+
556
+ @validate_arguments
557
+ def get_closed_period(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ClosedPeriod, Awaitable[ClosedPeriod]]: # noqa: E501
558
+ """[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501
559
+
560
+ Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # noqa: E501
561
+ This method makes a synchronous HTTP request by default. To make an
562
+ asynchronous HTTP request, please pass async_req=True
563
+
564
+ >>> thread = api.get_closed_period(scope, code, closed_period_id, as_at, property_keys, async_req=True)
565
+ >>> result = thread.get()
566
+
567
+ :param scope: The scope of the Timeline. (required)
568
+ :type scope: str
569
+ :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
570
+ :type code: str
571
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
572
+ :type closed_period_id: str
573
+ :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
574
+ :type as_at: datetime
575
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
576
+ :type property_keys: List[str]
577
+ :param async_req: Whether to execute the request asynchronously.
578
+ :type async_req: bool, optional
579
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
580
+ :param opts: Configuration options for this request
581
+ :type opts: ConfigurationOptions, optional
582
+ :return: Returns the result object.
583
+ If the method is called asynchronously,
584
+ returns the request thread.
585
+ :rtype: ClosedPeriod
586
+ """
587
+ kwargs['_return_http_data_only'] = True
588
+ if '_preload_content' in kwargs:
589
+ message = "Error! Please call the get_closed_period_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
590
+ raise ValueError(message)
591
+ if async_req is not None:
592
+ kwargs['async_req'] = async_req
593
+ return self.get_closed_period_with_http_info(scope, code, closed_period_id, as_at, property_keys, **kwargs) # noqa: E501
594
+
595
+ @validate_arguments
596
+ def get_closed_period_with_http_info(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the Timeline. Together with the scope this uniquely identifies the Timeline.")], closed_period_id : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
597
+ """[EXPERIMENTAL] GetClosedPeriod: Gets a Closed Period entity. # noqa: E501
598
+
599
+ Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId. # noqa: E501
600
+ This method makes a synchronous HTTP request by default. To make an
601
+ asynchronous HTTP request, please pass async_req=True
602
+
603
+ >>> thread = api.get_closed_period_with_http_info(scope, code, closed_period_id, as_at, property_keys, async_req=True)
604
+ >>> result = thread.get()
605
+
606
+ :param scope: The scope of the Timeline. (required)
607
+ :type scope: str
608
+ :param code: The code of the Timeline. Together with the scope this uniquely identifies the Timeline. (required)
609
+ :type code: str
610
+ :param closed_period_id: The id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod (required)
611
+ :type closed_period_id: str
612
+ :param as_at: The asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified.
613
+ :type as_at: datetime
614
+ :param property_keys: A list of property keys from the 'ClosedPeriod' domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example 'ClosedPeriod/system/Name'.
615
+ :type property_keys: List[str]
616
+ :param async_req: Whether to execute the request asynchronously.
617
+ :type async_req: bool, optional
618
+ :param _preload_content: if False, the ApiResponse.data will
619
+ be set to none and raw_data will store the
620
+ HTTP response body without reading/decoding.
621
+ Default is True.
622
+ :type _preload_content: bool, optional
623
+ :param _return_http_data_only: response data instead of ApiResponse
624
+ object with status code, headers, etc
625
+ :type _return_http_data_only: bool, optional
626
+ :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
627
+ :param opts: Configuration options for this request
628
+ :type opts: ConfigurationOptions, optional
629
+ :param _request_auth: set to override the auth_settings for an a single
630
+ request; this effectively ignores the authentication
631
+ in the spec for a single request.
632
+ :type _request_auth: dict, optional
633
+ :type _content_type: string, optional: force content-type for the request
634
+ :return: Returns the result object.
635
+ If the method is called asynchronously,
636
+ returns the request thread.
637
+ :rtype: tuple(ClosedPeriod, status_code(int), headers(HTTPHeaderDict))
638
+ """
639
+
640
+ _params = locals()
641
+
642
+ _all_params = [
643
+ 'scope',
644
+ 'code',
645
+ 'closed_period_id',
646
+ 'as_at',
647
+ 'property_keys'
648
+ ]
649
+ _all_params.extend(
650
+ [
651
+ 'async_req',
652
+ '_return_http_data_only',
653
+ '_preload_content',
654
+ '_request_timeout',
655
+ '_request_auth',
656
+ '_content_type',
657
+ '_headers',
658
+ 'opts'
659
+ ]
660
+ )
661
+
662
+ # validate the arguments
663
+ for _key, _val in _params['kwargs'].items():
664
+ if _key not in _all_params:
665
+ raise ApiTypeError(
666
+ "Got an unexpected keyword argument '%s'"
667
+ " to method get_closed_period" % _key
668
+ )
669
+ _params[_key] = _val
670
+ del _params['kwargs']
671
+
672
+ _collection_formats = {}
673
+
674
+ # process the path parameters
675
+ _path_params = {}
676
+ if _params['scope']:
677
+ _path_params['scope'] = _params['scope']
678
+
679
+ if _params['code']:
680
+ _path_params['code'] = _params['code']
681
+
682
+ if _params['closed_period_id']:
683
+ _path_params['closedPeriodId'] = _params['closed_period_id']
684
+
685
+
686
+ # process the query parameters
687
+ _query_params = []
688
+ if _params.get('as_at') is not None: # noqa: E501
689
+ if isinstance(_params['as_at'], datetime):
690
+ _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
691
+ else:
692
+ _query_params.append(('asAt', _params['as_at']))
693
+
694
+ if _params.get('property_keys') is not None: # noqa: E501
695
+ _query_params.append(('propertyKeys', _params['property_keys']))
696
+ _collection_formats['propertyKeys'] = 'multi'
697
+
698
+ # process the header parameters
699
+ _header_params = dict(_params.get('_headers', {}))
700
+ # process the form parameters
701
+ _form_params = []
702
+ _files = {}
703
+ # process the body parameter
704
+ _body_params = None
705
+ # set the HTTP header `Accept`
706
+ _header_params['Accept'] = self.api_client.select_header_accept(
707
+ ['text/plain', 'application/json', 'text/json']) # noqa: E501
708
+
709
+ # authentication setting
710
+ _auth_settings = ['oauth2'] # noqa: E501
711
+
712
+ _response_types_map = {
713
+ '200': "ClosedPeriod",
714
+ '400': "LusidValidationProblemDetails",
715
+ }
716
+
717
+ return self.api_client.call_api(
718
+ '/api/timelines/{scope}/{code}/closedperiods/{closedPeriodId}', 'GET',
719
+ _path_params,
720
+ _query_params,
721
+ _header_params,
722
+ body=_body_params,
723
+ post_params=_form_params,
724
+ files=_files,
725
+ response_types_map=_response_types_map,
726
+ auth_settings=_auth_settings,
727
+ async_req=_params.get('async_req'),
728
+ _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
729
+ _preload_content=_params.get('_preload_content', True),
730
+ _request_timeout=_params.get('_request_timeout'),
731
+ opts=_params.get('opts'),
732
+ collection_formats=_collection_formats,
733
+ _request_auth=_params.get('_request_auth'))
734
+
372
735
  @overload
373
736
  async def get_timeline(self, scope : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The scope of the specified Timeline.")], code : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="The code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified.")] = None, effective_at : Annotated[Optional[StrictStr], Field(description="The effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Timeline' domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example 'Timeline/system/Name'.")] = None, **kwargs) -> Timeline: # noqa: E501
374
737
  ...
lusid/configuration.py CHANGED
@@ -445,7 +445,7 @@ class Configuration:
445
445
  return "Python SDK Debug Report:\n"\
446
446
  "OS: {env}\n"\
447
447
  "Python Version: {pyversion}\n"\
448
- "Version of the API: 0.11.7194\n"\
448
+ "Version of the API: 0.11.7201\n"\
449
449
  "SDK Package Version: {package_version}".\
450
450
  format(env=sys.platform, pyversion=sys.version, package_version=package_version)
451
451