lusid-sdk 2.1.960__py3-none-any.whl → 2.1.962__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 +2 -0
- lusid/api/data_types_api.py +128 -32
- lusid/api/funds_api.py +252 -236
- lusid/api/portfolio_groups_api.py +24 -8
- lusid/api/transaction_portfolios_api.py +184 -19
- lusid/configuration.py +1 -1
- lusid/models/__init__.py +2 -0
- lusid/models/batch_upsert_transaction_settlement_instruction_response.py +137 -0
- lusid/models/settlement_configuration_category.py +7 -3
- lusid/models/settlement_instruction_query.py +9 -2
- {lusid_sdk-2.1.960.dist-info → lusid_sdk-2.1.962.dist-info}/METADATA +10 -8
- {lusid_sdk-2.1.960.dist-info → lusid_sdk-2.1.962.dist-info}/RECORD +13 -12
- {lusid_sdk-2.1.960.dist-info → lusid_sdk-2.1.962.dist-info}/WHEEL +0 -0
lusid/__init__.py
CHANGED
@@ -192,6 +192,7 @@ from lusid.models.batch_upsert_portfolio_access_metadata_response import BatchUp
|
|
192
192
|
from lusid.models.batch_upsert_portfolio_access_metadata_response_item import BatchUpsertPortfolioAccessMetadataResponseItem
|
193
193
|
from lusid.models.batch_upsert_portfolio_transactions_response import BatchUpsertPortfolioTransactionsResponse
|
194
194
|
from lusid.models.batch_upsert_property_definition_properties_response import BatchUpsertPropertyDefinitionPropertiesResponse
|
195
|
+
from lusid.models.batch_upsert_transaction_settlement_instruction_response import BatchUpsertTransactionSettlementInstructionResponse
|
195
196
|
from lusid.models.block import Block
|
196
197
|
from lusid.models.block_and_order_id_request import BlockAndOrderIdRequest
|
197
198
|
from lusid.models.block_and_orders import BlockAndOrders
|
@@ -1578,6 +1579,7 @@ __all__ = [
|
|
1578
1579
|
"BatchUpsertPortfolioAccessMetadataResponseItem",
|
1579
1580
|
"BatchUpsertPortfolioTransactionsResponse",
|
1580
1581
|
"BatchUpsertPropertyDefinitionPropertiesResponse",
|
1582
|
+
"BatchUpsertTransactionSettlementInstructionResponse",
|
1581
1583
|
"Block",
|
1582
1584
|
"BlockAndOrderIdRequest",
|
1583
1585
|
"BlockAndOrders",
|
lusid/api/data_types_api.py
CHANGED
@@ -382,22 +382,22 @@ class DataTypesApi:
|
|
382
382
|
|
383
383
|
|
384
384
|
@overload
|
385
|
-
async def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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
|
385
|
+
async def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> DataType: # noqa: E501
|
386
386
|
...
|
387
387
|
|
388
388
|
@overload
|
389
|
-
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, async_req: Optional[bool]=True, **kwargs) -> DataType: # noqa: E501
|
389
|
+
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> DataType: # noqa: E501
|
390
390
|
...
|
391
391
|
|
392
392
|
@validate_arguments
|
393
|
-
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, async_req: Optional[bool]=None, **kwargs) -> Union[DataType, Awaitable[DataType]]: # noqa: E501
|
393
|
+
def get_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DataType, Awaitable[DataType]]: # noqa: E501
|
394
394
|
"""GetDataType: Get data type definition # noqa: E501
|
395
395
|
|
396
396
|
Get the definition of a specified data type # noqa: E501
|
397
397
|
This method makes a synchronous HTTP request by default. To make an
|
398
398
|
asynchronous HTTP request, please pass async_req=True
|
399
399
|
|
400
|
-
>>> thread = api.get_data_type(scope, code, as_at, async_req=True)
|
400
|
+
>>> thread = api.get_data_type(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
401
401
|
>>> result = thread.get()
|
402
402
|
|
403
403
|
:param scope: The scope of the data type (required)
|
@@ -406,6 +406,12 @@ class DataTypesApi:
|
|
406
406
|
:type code: str
|
407
407
|
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.
|
408
408
|
:type as_at: datetime
|
409
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
410
|
+
:type timeline_scope: str
|
411
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
412
|
+
:type timeline_code: str
|
413
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
414
|
+
:type closed_period_id: str
|
409
415
|
:param async_req: Whether to execute the request asynchronously.
|
410
416
|
:type async_req: bool, optional
|
411
417
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -422,17 +428,17 @@ class DataTypesApi:
|
|
422
428
|
raise ValueError(message)
|
423
429
|
if async_req is not None:
|
424
430
|
kwargs['async_req'] = async_req
|
425
|
-
return self.get_data_type_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
431
|
+
return self.get_data_type_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
426
432
|
|
427
433
|
@validate_arguments
|
428
|
-
def get_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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) -> ApiResponse: # noqa: E501
|
434
|
+
def get_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, 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, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
429
435
|
"""GetDataType: Get data type definition # noqa: E501
|
430
436
|
|
431
437
|
Get the definition of a specified data type # noqa: E501
|
432
438
|
This method makes a synchronous HTTP request by default. To make an
|
433
439
|
asynchronous HTTP request, please pass async_req=True
|
434
440
|
|
435
|
-
>>> thread = api.get_data_type_with_http_info(scope, code, as_at, async_req=True)
|
441
|
+
>>> thread = api.get_data_type_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
436
442
|
>>> result = thread.get()
|
437
443
|
|
438
444
|
:param scope: The scope of the data type (required)
|
@@ -441,6 +447,12 @@ class DataTypesApi:
|
|
441
447
|
:type code: str
|
442
448
|
:param as_at: The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.
|
443
449
|
:type as_at: datetime
|
450
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
451
|
+
:type timeline_scope: str
|
452
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
453
|
+
:type timeline_code: str
|
454
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
455
|
+
:type closed_period_id: str
|
444
456
|
:param async_req: Whether to execute the request asynchronously.
|
445
457
|
:type async_req: bool, optional
|
446
458
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -470,7 +482,10 @@ class DataTypesApi:
|
|
470
482
|
_all_params = [
|
471
483
|
'scope',
|
472
484
|
'code',
|
473
|
-
'as_at'
|
485
|
+
'as_at',
|
486
|
+
'timeline_scope',
|
487
|
+
'timeline_code',
|
488
|
+
'closed_period_id'
|
474
489
|
]
|
475
490
|
_all_params.extend(
|
476
491
|
[
|
@@ -514,6 +529,15 @@ class DataTypesApi:
|
|
514
529
|
else:
|
515
530
|
_query_params.append(('asAt', _params['as_at']))
|
516
531
|
|
532
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
533
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
534
|
+
|
535
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
536
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
537
|
+
|
538
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
539
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
540
|
+
|
517
541
|
# process the header parameters
|
518
542
|
_header_params = dict(_params.get('_headers', {}))
|
519
543
|
# process the form parameters
|
@@ -553,22 +577,22 @@ class DataTypesApi:
|
|
553
577
|
|
554
578
|
|
555
579
|
@overload
|
556
|
-
async def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
580
|
+
async def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
557
581
|
...
|
558
582
|
|
559
583
|
@overload
|
560
|
-
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
584
|
+
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfIUnitDefinitionDto: # noqa: E501
|
561
585
|
...
|
562
586
|
|
563
587
|
@validate_arguments
|
564
|
-
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfIUnitDefinitionDto, Awaitable[ResourceListOfIUnitDefinitionDto]]: # noqa: E501
|
588
|
+
def get_units_from_data_type(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfIUnitDefinitionDto, Awaitable[ResourceListOfIUnitDefinitionDto]]: # noqa: E501
|
565
589
|
"""[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
|
566
590
|
|
567
591
|
Get the definitions of the specified units associated bound to a specific data type # noqa: E501
|
568
592
|
This method makes a synchronous HTTP request by default. To make an
|
569
593
|
asynchronous HTTP request, please pass async_req=True
|
570
594
|
|
571
|
-
>>> thread = api.get_units_from_data_type(scope, code, units, filter, as_at, async_req=True)
|
595
|
+
>>> thread = api.get_units_from_data_type(scope, code, units, filter, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
572
596
|
>>> result = thread.get()
|
573
597
|
|
574
598
|
:param scope: The scope of the data type (required)
|
@@ -581,6 +605,12 @@ class DataTypesApi:
|
|
581
605
|
:type filter: str
|
582
606
|
:param as_at: Optional. The as at of the requested data type
|
583
607
|
:type as_at: datetime
|
608
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
609
|
+
:type timeline_scope: str
|
610
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
611
|
+
:type timeline_code: str
|
612
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
613
|
+
:type closed_period_id: str
|
584
614
|
:param async_req: Whether to execute the request asynchronously.
|
585
615
|
:type async_req: bool, optional
|
586
616
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -597,17 +627,17 @@ class DataTypesApi:
|
|
597
627
|
raise ValueError(message)
|
598
628
|
if async_req is not None:
|
599
629
|
kwargs['async_req'] = async_req
|
600
|
-
return self.get_units_from_data_type_with_http_info(scope, code, units, filter, as_at, **kwargs) # noqa: E501
|
630
|
+
return self.get_units_from_data_type_with_http_info(scope, code, units, filter, as_at, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
601
631
|
|
602
632
|
@validate_arguments
|
603
|
-
def get_units_from_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
633
|
+
def get_units_from_data_type_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the data type")], code : Annotated[StrictStr, Field(..., description="The code of the data type")], units : Annotated[Optional[conlist(StrictStr)], Field(description="One or more unit identifiers for which the definition is being requested")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Schema, use \"schema eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, as_at : Annotated[Optional[datetime], Field(description="Optional. The as at of the requested data type")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
604
634
|
"""[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
|
605
635
|
|
606
636
|
Get the definitions of the specified units associated bound to a specific data type # noqa: E501
|
607
637
|
This method makes a synchronous HTTP request by default. To make an
|
608
638
|
asynchronous HTTP request, please pass async_req=True
|
609
639
|
|
610
|
-
>>> thread = api.get_units_from_data_type_with_http_info(scope, code, units, filter, as_at, async_req=True)
|
640
|
+
>>> thread = api.get_units_from_data_type_with_http_info(scope, code, units, filter, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
611
641
|
>>> result = thread.get()
|
612
642
|
|
613
643
|
:param scope: The scope of the data type (required)
|
@@ -620,6 +650,12 @@ class DataTypesApi:
|
|
620
650
|
:type filter: str
|
621
651
|
:param as_at: Optional. The as at of the requested data type
|
622
652
|
:type as_at: datetime
|
653
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
654
|
+
:type timeline_scope: str
|
655
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
656
|
+
:type timeline_code: str
|
657
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
658
|
+
:type closed_period_id: str
|
623
659
|
:param async_req: Whether to execute the request asynchronously.
|
624
660
|
:type async_req: bool, optional
|
625
661
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -651,7 +687,10 @@ class DataTypesApi:
|
|
651
687
|
'code',
|
652
688
|
'units',
|
653
689
|
'filter',
|
654
|
-
'as_at'
|
690
|
+
'as_at',
|
691
|
+
'timeline_scope',
|
692
|
+
'timeline_code',
|
693
|
+
'closed_period_id'
|
655
694
|
]
|
656
695
|
_all_params.extend(
|
657
696
|
[
|
@@ -702,6 +741,15 @@ class DataTypesApi:
|
|
702
741
|
else:
|
703
742
|
_query_params.append(('asAt', _params['as_at']))
|
704
743
|
|
744
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
745
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
746
|
+
|
747
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
748
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
749
|
+
|
750
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
751
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
752
|
+
|
705
753
|
# process the header parameters
|
706
754
|
_header_params = dict(_params.get('_headers', {}))
|
707
755
|
# process the form parameters
|
@@ -741,22 +789,22 @@ class DataTypesApi:
|
|
741
789
|
|
742
790
|
|
743
791
|
@overload
|
744
|
-
async def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
792
|
+
async def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
745
793
|
...
|
746
794
|
|
747
795
|
@overload
|
748
|
-
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
796
|
+
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfDataTypeSummary: # noqa: E501
|
749
797
|
...
|
750
798
|
|
751
799
|
@validate_arguments
|
752
|
-
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfDataTypeSummary, Awaitable[PagedResourceListOfDataTypeSummary]]: # noqa: E501
|
800
|
+
def list_data_type_summaries(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfDataTypeSummary, Awaitable[PagedResourceListOfDataTypeSummary]]: # noqa: E501
|
753
801
|
"""[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
|
754
802
|
|
755
803
|
List all data type summaries # noqa: E501
|
756
804
|
This method makes a synchronous HTTP request by default. To make an
|
757
805
|
asynchronous HTTP request, please pass async_req=True
|
758
806
|
|
759
|
-
>>> thread = api.list_data_type_summaries(as_at, page, limit, filter, sort_by, async_req=True)
|
807
|
+
>>> thread = api.list_data_type_summaries(as_at, page, limit, filter, sort_by, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
760
808
|
>>> result = thread.get()
|
761
809
|
|
762
810
|
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
|
@@ -769,6 +817,12 @@ class DataTypesApi:
|
|
769
817
|
:type filter: str
|
770
818
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
771
819
|
:type sort_by: List[str]
|
820
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
821
|
+
:type timeline_scope: str
|
822
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
823
|
+
:type timeline_code: str
|
824
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
825
|
+
:type closed_period_id: str
|
772
826
|
:param async_req: Whether to execute the request asynchronously.
|
773
827
|
:type async_req: bool, optional
|
774
828
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -785,17 +839,17 @@ class DataTypesApi:
|
|
785
839
|
raise ValueError(message)
|
786
840
|
if async_req is not None:
|
787
841
|
kwargs['async_req'] = async_req
|
788
|
-
return self.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, **kwargs) # noqa: E501
|
842
|
+
return self.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
789
843
|
|
790
844
|
@validate_arguments
|
791
|
-
def list_data_type_summaries_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
845
|
+
def list_data_type_summaries_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing data type summaries. This value is returned from the previous call. If a pagination token is provided, the filter, sortBy and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Scope, use \"id.scope eq 'myscope'\", to filter on Schema, use \"schema eq 'string'\", to filter on AcceptableValues use \"acceptableValues any (~ eq 'value')\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
792
846
|
"""[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
|
793
847
|
|
794
848
|
List all data type summaries # noqa: E501
|
795
849
|
This method makes a synchronous HTTP request by default. To make an
|
796
850
|
asynchronous HTTP request, please pass async_req=True
|
797
851
|
|
798
|
-
>>> thread = api.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, async_req=True)
|
852
|
+
>>> thread = api.list_data_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
799
853
|
>>> result = thread.get()
|
800
854
|
|
801
855
|
:param as_at: The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
|
@@ -808,6 +862,12 @@ class DataTypesApi:
|
|
808
862
|
:type filter: str
|
809
863
|
:param sort_by: A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
|
810
864
|
:type sort_by: List[str]
|
865
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
866
|
+
:type timeline_scope: str
|
867
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
868
|
+
:type timeline_code: str
|
869
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
870
|
+
:type closed_period_id: str
|
811
871
|
:param async_req: Whether to execute the request asynchronously.
|
812
872
|
:type async_req: bool, optional
|
813
873
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -839,7 +899,10 @@ class DataTypesApi:
|
|
839
899
|
'page',
|
840
900
|
'limit',
|
841
901
|
'filter',
|
842
|
-
'sort_by'
|
902
|
+
'sort_by',
|
903
|
+
'timeline_scope',
|
904
|
+
'timeline_code',
|
905
|
+
'closed_period_id'
|
843
906
|
]
|
844
907
|
_all_params.extend(
|
845
908
|
[
|
@@ -890,6 +953,15 @@ class DataTypesApi:
|
|
890
953
|
_query_params.append(('sortBy', _params['sort_by']))
|
891
954
|
_collection_formats['sortBy'] = 'multi'
|
892
955
|
|
956
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
957
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
958
|
+
|
959
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
960
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
961
|
+
|
962
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
963
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
964
|
+
|
893
965
|
# process the header parameters
|
894
966
|
_header_params = dict(_params.get('_headers', {}))
|
895
967
|
# process the form parameters
|
@@ -929,22 +1001,22 @@ class DataTypesApi:
|
|
929
1001
|
|
930
1002
|
|
931
1003
|
@overload
|
932
|
-
async def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
1004
|
+
async def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
933
1005
|
...
|
934
1006
|
|
935
1007
|
@overload
|
936
|
-
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
1008
|
+
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfDataType: # noqa: E501
|
937
1009
|
...
|
938
1010
|
|
939
1011
|
@validate_arguments
|
940
|
-
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfDataType, Awaitable[ResourceListOfDataType]]: # noqa: E501
|
1012
|
+
def list_data_types(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfDataType, Awaitable[ResourceListOfDataType]]: # noqa: E501
|
941
1013
|
"""ListDataTypes: List data types # noqa: E501
|
942
1014
|
|
943
1015
|
List all data types in a specified scope # noqa: E501
|
944
1016
|
This method makes a synchronous HTTP request by default. To make an
|
945
1017
|
asynchronous HTTP request, please pass async_req=True
|
946
1018
|
|
947
|
-
>>> thread = api.list_data_types(scope, as_at, include_system, sort_by, limit, filter, async_req=True)
|
1019
|
+
>>> thread = api.list_data_types(scope, as_at, include_system, sort_by, limit, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
948
1020
|
>>> result = thread.get()
|
949
1021
|
|
950
1022
|
:param scope: The requested scope of the data types (required)
|
@@ -959,6 +1031,12 @@ class DataTypesApi:
|
|
959
1031
|
:type limit: int
|
960
1032
|
:param filter: Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
961
1033
|
:type filter: str
|
1034
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
1035
|
+
:type timeline_scope: str
|
1036
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
1037
|
+
:type timeline_code: str
|
1038
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
1039
|
+
:type closed_period_id: str
|
962
1040
|
:param async_req: Whether to execute the request asynchronously.
|
963
1041
|
:type async_req: bool, optional
|
964
1042
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
@@ -975,17 +1053,17 @@ class DataTypesApi:
|
|
975
1053
|
raise ValueError(message)
|
976
1054
|
if async_req is not None:
|
977
1055
|
kwargs['async_req'] = async_req
|
978
|
-
return self.list_data_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, **kwargs) # noqa: E501
|
1056
|
+
return self.list_data_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
979
1057
|
|
980
1058
|
@validate_arguments
|
981
|
-
def list_data_types_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
1059
|
+
def list_data_types_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The requested scope of the data types")], as_at : Annotated[Optional[datetime], Field(description="The as at of the requested data types")] = None, include_system : Annotated[Optional[StrictBool], Field(description="Whether to additionally include those data types in the \"system\" scope")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.")] = None, timeline_scope : Annotated[Optional[StrictStr], Field( description="The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.")] = None, timeline_code : Annotated[Optional[StrictStr], Field( description="The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.")] = None, closed_period_id : Annotated[Optional[StrictStr], Field( description="The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
982
1060
|
"""ListDataTypes: List data types # noqa: E501
|
983
1061
|
|
984
1062
|
List all data types in a specified scope # noqa: E501
|
985
1063
|
This method makes a synchronous HTTP request by default. To make an
|
986
1064
|
asynchronous HTTP request, please pass async_req=True
|
987
1065
|
|
988
|
-
>>> thread = api.list_data_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, async_req=True)
|
1066
|
+
>>> thread = api.list_data_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
989
1067
|
>>> result = thread.get()
|
990
1068
|
|
991
1069
|
:param scope: The requested scope of the data types (required)
|
@@ -1000,6 +1078,12 @@ class DataTypesApi:
|
|
1000
1078
|
:type limit: int
|
1001
1079
|
:param filter: Optional. Expression to filter the result set. For example, to filter on the Display Name, use \"displayName eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
|
1002
1080
|
:type filter: str
|
1081
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
1082
|
+
:type timeline_scope: str
|
1083
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
1084
|
+
:type timeline_code: str
|
1085
|
+
:param closed_period_id: The code of the ClosedPeriod attached to the timeline, used to override the AsAt. If this is provided, timelineScope and timelineCode must also be provided.
|
1086
|
+
:type closed_period_id: str
|
1003
1087
|
:param async_req: Whether to execute the request asynchronously.
|
1004
1088
|
:type async_req: bool, optional
|
1005
1089
|
:param _preload_content: if False, the ApiResponse.data will
|
@@ -1032,7 +1116,10 @@ class DataTypesApi:
|
|
1032
1116
|
'include_system',
|
1033
1117
|
'sort_by',
|
1034
1118
|
'limit',
|
1035
|
-
'filter'
|
1119
|
+
'filter',
|
1120
|
+
'timeline_scope',
|
1121
|
+
'timeline_code',
|
1122
|
+
'closed_period_id'
|
1036
1123
|
]
|
1037
1124
|
_all_params.extend(
|
1038
1125
|
[
|
@@ -1086,6 +1173,15 @@ class DataTypesApi:
|
|
1086
1173
|
if _params.get('filter') is not None: # noqa: E501
|
1087
1174
|
_query_params.append(('filter', _params['filter']))
|
1088
1175
|
|
1176
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
1177
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
1178
|
+
|
1179
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
1180
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
1181
|
+
|
1182
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
1183
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
1184
|
+
|
1089
1185
|
# process the header parameters
|
1090
1186
|
_header_params = dict(_params.get('_headers', {}))
|
1091
1187
|
# process the form parameters
|