lusid-sdk 2.1.952__py3-none-any.whl → 2.1.953__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/api/abor_api.py +170 -2
- lusid/api/configuration_recipe_api.py +192 -48
- lusid/api/group_reconciliations_api.py +4 -4
- lusid/api/portfolio_groups_api.py +24 -8
- lusid/api/quotes_api.py +2 -2
- lusid/configuration.py +1 -1
- lusid/models/conversion_event.py +6 -6
- lusid/models/list_complex_market_data_with_meta_data_response.py +1 -1
- lusid/models/mapping_rule.py +1 -1
- lusid/models/market_data_specific_rule.py +1 -1
- lusid/models/reconciled_transaction.py +2 -2
- {lusid_sdk-2.1.952.dist-info → lusid_sdk-2.1.953.dist-info}/METADATA +3 -2
- {lusid_sdk-2.1.952.dist-info → lusid_sdk-2.1.953.dist-info}/RECORD +14 -14
- {lusid_sdk-2.1.952.dist-info → lusid_sdk-2.1.953.dist-info}/WHEEL +0 -0
|
@@ -382,22 +382,22 @@ class ConfigurationRecipeApi:
|
|
|
382
382
|
|
|
383
383
|
|
|
384
384
|
@overload
|
|
385
|
-
async def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GetRecipeResponse: # noqa: E501
|
|
385
|
+
async def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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) -> GetRecipeResponse: # noqa: E501
|
|
386
386
|
...
|
|
387
387
|
|
|
388
388
|
@overload
|
|
389
|
-
def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetRecipeResponse: # noqa: E501
|
|
389
|
+
def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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) -> GetRecipeResponse: # noqa: E501
|
|
390
390
|
...
|
|
391
391
|
|
|
392
392
|
@validate_arguments
|
|
393
|
-
def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetRecipeResponse, Awaitable[GetRecipeResponse]]: # noqa: E501
|
|
393
|
+
def get_configuration_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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[GetRecipeResponse, Awaitable[GetRecipeResponse]]: # noqa: E501
|
|
394
394
|
"""GetConfigurationRecipe: Get Configuration Recipe # noqa: E501
|
|
395
395
|
|
|
396
396
|
Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_configuration_recipe(scope, code, as_at, async_req=True)
|
|
400
|
+
>>> thread = api.get_configuration_recipe(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 Configuration Recipe to retrieve. (required)
|
|
@@ -406,6 +406,12 @@ class ConfigurationRecipeApi:
|
|
|
406
406
|
:type code: str
|
|
407
407
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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 ConfigurationRecipeApi:
|
|
|
422
428
|
raise ValueError(message)
|
|
423
429
|
if async_req is not None:
|
|
424
430
|
kwargs['async_req'] = async_req
|
|
425
|
-
return self.get_configuration_recipe_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
431
|
+
return self.get_configuration_recipe_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_configuration_recipe_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
434
|
+
def get_configuration_recipe_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the recipe to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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
|
"""GetConfigurationRecipe: Get Configuration Recipe # noqa: E501
|
|
430
436
|
|
|
431
437
|
Get a Configuration Recipe from a single scope. The response will return either the recipe that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_configuration_recipe_with_http_info(scope, code, as_at, async_req=True)
|
|
441
|
+
>>> thread = api.get_configuration_recipe_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 Configuration Recipe to retrieve. (required)
|
|
@@ -441,6 +447,12 @@ class ConfigurationRecipeApi:
|
|
|
441
447
|
:type code: str
|
|
442
448
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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 ConfigurationRecipeApi:
|
|
|
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 ConfigurationRecipeApi:
|
|
|
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 ConfigurationRecipeApi:
|
|
|
553
577
|
|
|
554
578
|
|
|
555
579
|
@overload
|
|
556
|
-
async def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GetRecipeResponse: # noqa: E501
|
|
580
|
+
async def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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) -> GetRecipeResponse: # noqa: E501
|
|
557
581
|
...
|
|
558
582
|
|
|
559
583
|
@overload
|
|
560
|
-
def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetRecipeResponse: # noqa: E501
|
|
584
|
+
def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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) -> GetRecipeResponse: # noqa: E501
|
|
561
585
|
...
|
|
562
586
|
|
|
563
587
|
@validate_arguments
|
|
564
|
-
def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetRecipeResponse, Awaitable[GetRecipeResponse]]: # noqa: E501
|
|
588
|
+
def get_derived_recipe(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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[GetRecipeResponse, Awaitable[GetRecipeResponse]]: # noqa: E501
|
|
565
589
|
"""GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501
|
|
566
590
|
|
|
567
591
|
If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned. # 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_derived_recipe(scope, code, as_at, async_req=True)
|
|
595
|
+
>>> thread = api.get_derived_recipe(scope, code, 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 Configuration Recipe or Recipe Composer to return. (required)
|
|
@@ -577,6 +601,12 @@ class ConfigurationRecipeApi:
|
|
|
577
601
|
:type code: str
|
|
578
602
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
|
|
579
603
|
:type as_at: datetime
|
|
604
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
605
|
+
:type timeline_scope: str
|
|
606
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
607
|
+
:type timeline_code: str
|
|
608
|
+
: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.
|
|
609
|
+
:type closed_period_id: str
|
|
580
610
|
:param async_req: Whether to execute the request asynchronously.
|
|
581
611
|
:type async_req: bool, optional
|
|
582
612
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -593,17 +623,17 @@ class ConfigurationRecipeApi:
|
|
|
593
623
|
raise ValueError(message)
|
|
594
624
|
if async_req is not None:
|
|
595
625
|
kwargs['async_req'] = async_req
|
|
596
|
-
return self.get_derived_recipe_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
626
|
+
return self.get_derived_recipe_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
|
597
627
|
|
|
598
628
|
@validate_arguments
|
|
599
|
-
def get_derived_recipe_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
629
|
+
def get_derived_recipe_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Configuration Recipe or Recipe Composer to return.")], code : Annotated[StrictStr, Field(..., description="The code of the Configuration Recipe or Recipe Composer to return.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version 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
|
|
600
630
|
"""GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501
|
|
601
631
|
|
|
602
632
|
If scope-code is referring to a Configuration Recipe it is returned, if it refers to Recipe Composer, it is expanded into a Configuration Recipe and returned. # noqa: E501
|
|
603
633
|
This method makes a synchronous HTTP request by default. To make an
|
|
604
634
|
asynchronous HTTP request, please pass async_req=True
|
|
605
635
|
|
|
606
|
-
>>> thread = api.get_derived_recipe_with_http_info(scope, code, as_at, async_req=True)
|
|
636
|
+
>>> thread = api.get_derived_recipe_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
607
637
|
>>> result = thread.get()
|
|
608
638
|
|
|
609
639
|
:param scope: The scope of the Configuration Recipe or Recipe Composer to return. (required)
|
|
@@ -612,6 +642,12 @@ class ConfigurationRecipeApi:
|
|
|
612
642
|
:type code: str
|
|
613
643
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
|
|
614
644
|
:type as_at: datetime
|
|
645
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
646
|
+
:type timeline_scope: str
|
|
647
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
648
|
+
:type timeline_code: str
|
|
649
|
+
: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.
|
|
650
|
+
:type closed_period_id: str
|
|
615
651
|
:param async_req: Whether to execute the request asynchronously.
|
|
616
652
|
:type async_req: bool, optional
|
|
617
653
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -641,7 +677,10 @@ class ConfigurationRecipeApi:
|
|
|
641
677
|
_all_params = [
|
|
642
678
|
'scope',
|
|
643
679
|
'code',
|
|
644
|
-
'as_at'
|
|
680
|
+
'as_at',
|
|
681
|
+
'timeline_scope',
|
|
682
|
+
'timeline_code',
|
|
683
|
+
'closed_period_id'
|
|
645
684
|
]
|
|
646
685
|
_all_params.extend(
|
|
647
686
|
[
|
|
@@ -685,6 +724,15 @@ class ConfigurationRecipeApi:
|
|
|
685
724
|
else:
|
|
686
725
|
_query_params.append(('asAt', _params['as_at']))
|
|
687
726
|
|
|
727
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
|
728
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
|
729
|
+
|
|
730
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
|
731
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
|
732
|
+
|
|
733
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
|
734
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
|
735
|
+
|
|
688
736
|
# process the header parameters
|
|
689
737
|
_header_params = dict(_params.get('_headers', {}))
|
|
690
738
|
# process the form parameters
|
|
@@ -724,22 +772,22 @@ class ConfigurationRecipeApi:
|
|
|
724
772
|
|
|
725
773
|
|
|
726
774
|
@overload
|
|
727
|
-
async def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GetRecipeComposerResponse: # noqa: E501
|
|
775
|
+
async def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version 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) -> GetRecipeComposerResponse: # noqa: E501
|
|
728
776
|
...
|
|
729
777
|
|
|
730
778
|
@overload
|
|
731
|
-
def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetRecipeComposerResponse: # noqa: E501
|
|
779
|
+
def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version 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) -> GetRecipeComposerResponse: # noqa: E501
|
|
732
780
|
...
|
|
733
781
|
|
|
734
782
|
@validate_arguments
|
|
735
|
-
def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetRecipeComposerResponse, Awaitable[GetRecipeComposerResponse]]: # noqa: E501
|
|
783
|
+
def get_recipe_composer(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version 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[GetRecipeComposerResponse, Awaitable[GetRecipeComposerResponse]]: # noqa: E501
|
|
736
784
|
"""GetRecipeComposer: Get Recipe Composer # noqa: E501
|
|
737
785
|
|
|
738
786
|
Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501
|
|
739
787
|
This method makes a synchronous HTTP request by default. To make an
|
|
740
788
|
asynchronous HTTP request, please pass async_req=True
|
|
741
789
|
|
|
742
|
-
>>> thread = api.get_recipe_composer(scope, code, as_at, async_req=True)
|
|
790
|
+
>>> thread = api.get_recipe_composer(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
743
791
|
>>> result = thread.get()
|
|
744
792
|
|
|
745
793
|
:param scope: The scope of the Recipe Composer to retrieve. (required)
|
|
@@ -748,6 +796,12 @@ class ConfigurationRecipeApi:
|
|
|
748
796
|
:type code: str
|
|
749
797
|
:param as_at: The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
|
|
750
798
|
:type as_at: datetime
|
|
799
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
800
|
+
:type timeline_scope: str
|
|
801
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
802
|
+
:type timeline_code: str
|
|
803
|
+
: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.
|
|
804
|
+
:type closed_period_id: str
|
|
751
805
|
:param async_req: Whether to execute the request asynchronously.
|
|
752
806
|
:type async_req: bool, optional
|
|
753
807
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -764,17 +818,17 @@ class ConfigurationRecipeApi:
|
|
|
764
818
|
raise ValueError(message)
|
|
765
819
|
if async_req is not None:
|
|
766
820
|
kwargs['async_req'] = async_req
|
|
767
|
-
return self.get_recipe_composer_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
821
|
+
return self.get_recipe_composer_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
|
768
822
|
|
|
769
823
|
@validate_arguments
|
|
770
|
-
def get_recipe_composer_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
824
|
+
def get_recipe_composer_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Recipe Composer to retrieve.")], code : Annotated[StrictStr, Field(..., description="The name of the Recipe Composer to retrieve the data for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version 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
|
|
771
825
|
"""GetRecipeComposer: Get Recipe Composer # noqa: E501
|
|
772
826
|
|
|
773
827
|
Get a Recipe Composer from a single scope. The response will return either the recipe composer that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # noqa: E501
|
|
774
828
|
This method makes a synchronous HTTP request by default. To make an
|
|
775
829
|
asynchronous HTTP request, please pass async_req=True
|
|
776
830
|
|
|
777
|
-
>>> thread = api.get_recipe_composer_with_http_info(scope, code, as_at, async_req=True)
|
|
831
|
+
>>> thread = api.get_recipe_composer_with_http_info(scope, code, as_at, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
778
832
|
>>> result = thread.get()
|
|
779
833
|
|
|
780
834
|
:param scope: The scope of the Recipe Composer to retrieve. (required)
|
|
@@ -783,6 +837,12 @@ class ConfigurationRecipeApi:
|
|
|
783
837
|
:type code: str
|
|
784
838
|
:param as_at: The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
|
|
785
839
|
:type as_at: datetime
|
|
840
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
841
|
+
:type timeline_scope: str
|
|
842
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
843
|
+
:type timeline_code: str
|
|
844
|
+
: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.
|
|
845
|
+
:type closed_period_id: str
|
|
786
846
|
:param async_req: Whether to execute the request asynchronously.
|
|
787
847
|
:type async_req: bool, optional
|
|
788
848
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -812,7 +872,10 @@ class ConfigurationRecipeApi:
|
|
|
812
872
|
_all_params = [
|
|
813
873
|
'scope',
|
|
814
874
|
'code',
|
|
815
|
-
'as_at'
|
|
875
|
+
'as_at',
|
|
876
|
+
'timeline_scope',
|
|
877
|
+
'timeline_code',
|
|
878
|
+
'closed_period_id'
|
|
816
879
|
]
|
|
817
880
|
_all_params.extend(
|
|
818
881
|
[
|
|
@@ -856,6 +919,15 @@ class ConfigurationRecipeApi:
|
|
|
856
919
|
else:
|
|
857
920
|
_query_params.append(('asAt', _params['as_at']))
|
|
858
921
|
|
|
922
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
|
923
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
|
924
|
+
|
|
925
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
|
926
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
|
927
|
+
|
|
928
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
|
929
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
|
930
|
+
|
|
859
931
|
# process the header parameters
|
|
860
932
|
_header_params = dict(_params.get('_headers', {}))
|
|
861
933
|
# process the form parameters
|
|
@@ -1054,28 +1126,34 @@ class ConfigurationRecipeApi:
|
|
|
1054
1126
|
|
|
1055
1127
|
|
|
1056
1128
|
@overload
|
|
1057
|
-
async def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1129
|
+
async def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, 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) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1058
1130
|
...
|
|
1059
1131
|
|
|
1060
1132
|
@overload
|
|
1061
|
-
def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1133
|
+
def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, 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) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1062
1134
|
...
|
|
1063
1135
|
|
|
1064
1136
|
@validate_arguments
|
|
1065
|
-
def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfGetRecipeResponse, Awaitable[ResourceListOfGetRecipeResponse]]: # noqa: E501
|
|
1137
|
+
def list_configuration_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, 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[ResourceListOfGetRecipeResponse, Awaitable[ResourceListOfGetRecipeResponse]]: # noqa: E501
|
|
1066
1138
|
"""ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
|
|
1067
1139
|
|
|
1068
1140
|
List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers. # noqa: E501
|
|
1069
1141
|
This method makes a synchronous HTTP request by default. To make an
|
|
1070
1142
|
asynchronous HTTP request, please pass async_req=True
|
|
1071
1143
|
|
|
1072
|
-
>>> thread = api.list_configuration_recipes(as_at, filter, async_req=True)
|
|
1144
|
+
>>> thread = api.list_configuration_recipes(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1073
1145
|
>>> result = thread.get()
|
|
1074
1146
|
|
|
1075
1147
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1076
1148
|
:type as_at: datetime
|
|
1077
1149
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
1078
1150
|
:type filter: str
|
|
1151
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1152
|
+
:type timeline_scope: str
|
|
1153
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1154
|
+
:type timeline_code: str
|
|
1155
|
+
: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.
|
|
1156
|
+
:type closed_period_id: str
|
|
1079
1157
|
:param async_req: Whether to execute the request asynchronously.
|
|
1080
1158
|
:type async_req: bool, optional
|
|
1081
1159
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1092,23 +1170,29 @@ class ConfigurationRecipeApi:
|
|
|
1092
1170
|
raise ValueError(message)
|
|
1093
1171
|
if async_req is not None:
|
|
1094
1172
|
kwargs['async_req'] = async_req
|
|
1095
|
-
return self.list_configuration_recipes_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1173
|
+
return self.list_configuration_recipes_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
|
1096
1174
|
|
|
1097
1175
|
@validate_arguments
|
|
1098
|
-
def list_configuration_recipes_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1176
|
+
def list_configuration_recipes_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.")] = None, 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
|
|
1099
1177
|
"""ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
|
|
1100
1178
|
|
|
1101
1179
|
List the set of configuration recipes at the specified date/time and scope. Note this only returns recipes stored directly and does not include any recipes expanded from recipe composers. # noqa: E501
|
|
1102
1180
|
This method makes a synchronous HTTP request by default. To make an
|
|
1103
1181
|
asynchronous HTTP request, please pass async_req=True
|
|
1104
1182
|
|
|
1105
|
-
>>> thread = api.list_configuration_recipes_with_http_info(as_at, filter, async_req=True)
|
|
1183
|
+
>>> thread = api.list_configuration_recipes_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1106
1184
|
>>> result = thread.get()
|
|
1107
1185
|
|
|
1108
1186
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1109
1187
|
:type as_at: datetime
|
|
1110
1188
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
1111
1189
|
:type filter: str
|
|
1190
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1191
|
+
:type timeline_scope: str
|
|
1192
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1193
|
+
:type timeline_code: str
|
|
1194
|
+
: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.
|
|
1195
|
+
:type closed_period_id: str
|
|
1112
1196
|
:param async_req: Whether to execute the request asynchronously.
|
|
1113
1197
|
:type async_req: bool, optional
|
|
1114
1198
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1137,7 +1221,10 @@ class ConfigurationRecipeApi:
|
|
|
1137
1221
|
|
|
1138
1222
|
_all_params = [
|
|
1139
1223
|
'as_at',
|
|
1140
|
-
'filter'
|
|
1224
|
+
'filter',
|
|
1225
|
+
'timeline_scope',
|
|
1226
|
+
'timeline_code',
|
|
1227
|
+
'closed_period_id'
|
|
1141
1228
|
]
|
|
1142
1229
|
_all_params.extend(
|
|
1143
1230
|
[
|
|
@@ -1178,6 +1265,15 @@ class ConfigurationRecipeApi:
|
|
|
1178
1265
|
if _params.get('filter') is not None: # noqa: E501
|
|
1179
1266
|
_query_params.append(('filter', _params['filter']))
|
|
1180
1267
|
|
|
1268
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
|
1269
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
|
1270
|
+
|
|
1271
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
|
1272
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
|
1273
|
+
|
|
1274
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
|
1275
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
|
1276
|
+
|
|
1181
1277
|
# process the header parameters
|
|
1182
1278
|
_header_params = dict(_params.get('_headers', {}))
|
|
1183
1279
|
# process the form parameters
|
|
@@ -1217,28 +1313,34 @@ class ConfigurationRecipeApi:
|
|
|
1217
1313
|
|
|
1218
1314
|
|
|
1219
1315
|
@overload
|
|
1220
|
-
async def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, **kwargs) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1316
|
+
async def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1221
1317
|
...
|
|
1222
1318
|
|
|
1223
1319
|
@overload
|
|
1224
|
-
def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1320
|
+
def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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) -> ResourceListOfGetRecipeResponse: # noqa: E501
|
|
1225
1321
|
...
|
|
1226
1322
|
|
|
1227
1323
|
@validate_arguments
|
|
1228
|
-
def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfGetRecipeResponse, Awaitable[ResourceListOfGetRecipeResponse]]: # noqa: E501
|
|
1324
|
+
def list_derived_recipes(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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[ResourceListOfGetRecipeResponse, Awaitable[ResourceListOfGetRecipeResponse]]: # noqa: E501
|
|
1229
1325
|
"""ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501
|
|
1230
1326
|
|
|
1231
1327
|
This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints. Recipe Composers that fail to generate a valid Configuration Recipe will not be reported. # noqa: E501
|
|
1232
1328
|
This method makes a synchronous HTTP request by default. To make an
|
|
1233
1329
|
asynchronous HTTP request, please pass async_req=True
|
|
1234
1330
|
|
|
1235
|
-
>>> thread = api.list_derived_recipes(as_at, filter, async_req=True)
|
|
1331
|
+
>>> thread = api.list_derived_recipes(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1236
1332
|
>>> result = thread.get()
|
|
1237
1333
|
|
|
1238
1334
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1239
1335
|
:type as_at: datetime
|
|
1240
1336
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1241
1337
|
:type filter: str
|
|
1338
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1339
|
+
:type timeline_scope: str
|
|
1340
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1341
|
+
:type timeline_code: str
|
|
1342
|
+
: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.
|
|
1343
|
+
:type closed_period_id: str
|
|
1242
1344
|
:param async_req: Whether to execute the request asynchronously.
|
|
1243
1345
|
:type async_req: bool, optional
|
|
1244
1346
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1255,23 +1357,29 @@ class ConfigurationRecipeApi:
|
|
|
1255
1357
|
raise ValueError(message)
|
|
1256
1358
|
if async_req is not None:
|
|
1257
1359
|
kwargs['async_req'] = async_req
|
|
1258
|
-
return self.list_derived_recipes_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1360
|
+
return self.list_derived_recipes_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
|
1259
1361
|
|
|
1260
1362
|
@validate_arguments
|
|
1261
|
-
def list_derived_recipes_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1363
|
+
def list_derived_recipes_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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
|
|
1262
1364
|
"""ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501
|
|
1263
1365
|
|
|
1264
1366
|
This endpoints returns a union of the output of ListConfigurationRecipes and the resolved Recipe Composers from the ListRecipeComposers endpoints. Recipe Composers that fail to generate a valid Configuration Recipe will not be reported. # noqa: E501
|
|
1265
1367
|
This method makes a synchronous HTTP request by default. To make an
|
|
1266
1368
|
asynchronous HTTP request, please pass async_req=True
|
|
1267
1369
|
|
|
1268
|
-
>>> thread = api.list_derived_recipes_with_http_info(as_at, filter, async_req=True)
|
|
1370
|
+
>>> thread = api.list_derived_recipes_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1269
1371
|
>>> result = thread.get()
|
|
1270
1372
|
|
|
1271
1373
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1272
1374
|
:type as_at: datetime
|
|
1273
1375
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1274
1376
|
:type filter: str
|
|
1377
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1378
|
+
:type timeline_scope: str
|
|
1379
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1380
|
+
:type timeline_code: str
|
|
1381
|
+
: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.
|
|
1382
|
+
:type closed_period_id: str
|
|
1275
1383
|
:param async_req: Whether to execute the request asynchronously.
|
|
1276
1384
|
:type async_req: bool, optional
|
|
1277
1385
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1300,7 +1408,10 @@ class ConfigurationRecipeApi:
|
|
|
1300
1408
|
|
|
1301
1409
|
_all_params = [
|
|
1302
1410
|
'as_at',
|
|
1303
|
-
'filter'
|
|
1411
|
+
'filter',
|
|
1412
|
+
'timeline_scope',
|
|
1413
|
+
'timeline_code',
|
|
1414
|
+
'closed_period_id'
|
|
1304
1415
|
]
|
|
1305
1416
|
_all_params.extend(
|
|
1306
1417
|
[
|
|
@@ -1341,6 +1452,15 @@ class ConfigurationRecipeApi:
|
|
|
1341
1452
|
if _params.get('filter') is not None: # noqa: E501
|
|
1342
1453
|
_query_params.append(('filter', _params['filter']))
|
|
1343
1454
|
|
|
1455
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
|
1456
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
|
1457
|
+
|
|
1458
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
|
1459
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
|
1460
|
+
|
|
1461
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
|
1462
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
|
1463
|
+
|
|
1344
1464
|
# process the header parameters
|
|
1345
1465
|
_header_params = dict(_params.get('_headers', {}))
|
|
1346
1466
|
# process the form parameters
|
|
@@ -1380,28 +1500,34 @@ class ConfigurationRecipeApi:
|
|
|
1380
1500
|
|
|
1381
1501
|
|
|
1382
1502
|
@overload
|
|
1383
|
-
async def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, **kwargs) -> ResourceListOfGetRecipeComposerResponse: # noqa: E501
|
|
1503
|
+
async def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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) -> ResourceListOfGetRecipeComposerResponse: # noqa: E501
|
|
1384
1504
|
...
|
|
1385
1505
|
|
|
1386
1506
|
@overload
|
|
1387
|
-
def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, async_req: Optional[bool]=True, **kwargs) -> ResourceListOfGetRecipeComposerResponse: # noqa: E501
|
|
1507
|
+
def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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) -> ResourceListOfGetRecipeComposerResponse: # noqa: E501
|
|
1388
1508
|
...
|
|
1389
1509
|
|
|
1390
1510
|
@validate_arguments
|
|
1391
|
-
def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfGetRecipeComposerResponse, Awaitable[ResourceListOfGetRecipeComposerResponse]]: # noqa: E501
|
|
1511
|
+
def list_recipe_composers(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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[ResourceListOfGetRecipeComposerResponse, Awaitable[ResourceListOfGetRecipeComposerResponse]]: # noqa: E501
|
|
1392
1512
|
"""ListRecipeComposers: List the set of Recipe Composers # noqa: E501
|
|
1393
1513
|
|
|
1394
1514
|
List the set of Recipe Composers at the specified date/time and scope # noqa: E501
|
|
1395
1515
|
This method makes a synchronous HTTP request by default. To make an
|
|
1396
1516
|
asynchronous HTTP request, please pass async_req=True
|
|
1397
1517
|
|
|
1398
|
-
>>> thread = api.list_recipe_composers(as_at, filter, async_req=True)
|
|
1518
|
+
>>> thread = api.list_recipe_composers(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1399
1519
|
>>> result = thread.get()
|
|
1400
1520
|
|
|
1401
1521
|
:param as_at: The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
|
|
1402
1522
|
:type as_at: datetime
|
|
1403
1523
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1404
1524
|
:type filter: str
|
|
1525
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1526
|
+
:type timeline_scope: str
|
|
1527
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1528
|
+
:type timeline_code: str
|
|
1529
|
+
: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.
|
|
1530
|
+
:type closed_period_id: str
|
|
1405
1531
|
:param async_req: Whether to execute the request asynchronously.
|
|
1406
1532
|
:type async_req: bool, optional
|
|
1407
1533
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1418,23 +1544,29 @@ class ConfigurationRecipeApi:
|
|
|
1418
1544
|
raise ValueError(message)
|
|
1419
1545
|
if async_req is not None:
|
|
1420
1546
|
kwargs['async_req'] = async_req
|
|
1421
|
-
return self.list_recipe_composers_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1547
|
+
return self.list_recipe_composers_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, **kwargs) # noqa: E501
|
|
1422
1548
|
|
|
1423
1549
|
@validate_arguments
|
|
1424
|
-
def list_recipe_composers_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1550
|
+
def list_recipe_composers_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set, note this functionality is not yet enabled for this endpoint.")] = 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
|
|
1425
1551
|
"""ListRecipeComposers: List the set of Recipe Composers # noqa: E501
|
|
1426
1552
|
|
|
1427
1553
|
List the set of Recipe Composers at the specified date/time and scope # noqa: E501
|
|
1428
1554
|
This method makes a synchronous HTTP request by default. To make an
|
|
1429
1555
|
asynchronous HTTP request, please pass async_req=True
|
|
1430
1556
|
|
|
1431
|
-
>>> thread = api.list_recipe_composers_with_http_info(as_at, filter, async_req=True)
|
|
1557
|
+
>>> thread = api.list_recipe_composers_with_http_info(as_at, filter, timeline_scope, timeline_code, closed_period_id, async_req=True)
|
|
1432
1558
|
>>> result = thread.get()
|
|
1433
1559
|
|
|
1434
1560
|
:param as_at: The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
|
|
1435
1561
|
:type as_at: datetime
|
|
1436
1562
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1437
1563
|
:type filter: str
|
|
1564
|
+
:param timeline_scope: The scope of the Timeline, used to override the AsAt. If this is provided, timelineCode and closedPeriodId must also be provided.
|
|
1565
|
+
:type timeline_scope: str
|
|
1566
|
+
:param timeline_code: The code of the Timeline, used to override the AsAt. If this is provided, timelineScope and closedPeriodId must also be provided.
|
|
1567
|
+
:type timeline_code: str
|
|
1568
|
+
: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.
|
|
1569
|
+
:type closed_period_id: str
|
|
1438
1570
|
:param async_req: Whether to execute the request asynchronously.
|
|
1439
1571
|
:type async_req: bool, optional
|
|
1440
1572
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1463,7 +1595,10 @@ class ConfigurationRecipeApi:
|
|
|
1463
1595
|
|
|
1464
1596
|
_all_params = [
|
|
1465
1597
|
'as_at',
|
|
1466
|
-
'filter'
|
|
1598
|
+
'filter',
|
|
1599
|
+
'timeline_scope',
|
|
1600
|
+
'timeline_code',
|
|
1601
|
+
'closed_period_id'
|
|
1467
1602
|
]
|
|
1468
1603
|
_all_params.extend(
|
|
1469
1604
|
[
|
|
@@ -1504,6 +1639,15 @@ class ConfigurationRecipeApi:
|
|
|
1504
1639
|
if _params.get('filter') is not None: # noqa: E501
|
|
1505
1640
|
_query_params.append(('filter', _params['filter']))
|
|
1506
1641
|
|
|
1642
|
+
if _params.get('timeline_scope') is not None: # noqa: E501
|
|
1643
|
+
_query_params.append(('timelineScope', _params['timeline_scope']))
|
|
1644
|
+
|
|
1645
|
+
if _params.get('timeline_code') is not None: # noqa: E501
|
|
1646
|
+
_query_params.append(('timelineCode', _params['timeline_code']))
|
|
1647
|
+
|
|
1648
|
+
if _params.get('closed_period_id') is not None: # noqa: E501
|
|
1649
|
+
_query_params.append(('closedPeriodId', _params['closed_period_id']))
|
|
1650
|
+
|
|
1507
1651
|
# process the header parameters
|
|
1508
1652
|
_header_params = dict(_params.get('_headers', {}))
|
|
1509
1653
|
# process the form parameters
|