lusid-sdk 2.1.968__py3-none-any.whl → 2.1.970__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/complex_market_data_api.py +7 -15
- lusid/api/configuration_recipe_api.py +48 -192
- lusid/api/data_types_api.py +32 -128
- lusid/api/transaction_configuration_api.py +32 -128
- lusid/configuration.py +1 -1
- lusid/models/flexible_repo_full_closure_event.py +2 -2
- lusid/models/flexible_repo_partial_closure_event.py +3 -3
- {lusid_sdk-2.1.968.dist-info → lusid_sdk-2.1.970.dist-info}/METADATA +1 -1
- {lusid_sdk-2.1.968.dist-info → lusid_sdk-2.1.970.dist-info}/RECORD +10 -10
- {lusid_sdk-2.1.968.dist-info → lusid_sdk-2.1.970.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,
|
|
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
|
|
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,
|
|
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
|
|
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,
|
|
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
|
|
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,
|
|
400
|
+
>>> thread = api.get_configuration_recipe(scope, code, as_at, async_req=True)
|
|
401
401
|
>>> result = thread.get()
|
|
402
402
|
|
|
403
403
|
:param scope: The scope of the Configuration Recipe to retrieve. (required)
|
|
@@ -406,12 +406,6 @@ 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
|
|
415
409
|
:param async_req: Whether to execute the request asynchronously.
|
|
416
410
|
:type async_req: bool, optional
|
|
417
411
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -428,17 +422,17 @@ class ConfigurationRecipeApi:
|
|
|
428
422
|
raise ValueError(message)
|
|
429
423
|
if async_req is not None:
|
|
430
424
|
kwargs['async_req'] = async_req
|
|
431
|
-
return self.get_configuration_recipe_with_http_info(scope, code, as_at,
|
|
425
|
+
return self.get_configuration_recipe_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
432
426
|
|
|
433
427
|
@validate_arguments
|
|
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,
|
|
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
|
|
435
429
|
"""GetConfigurationRecipe: Get Configuration Recipe # noqa: E501
|
|
436
430
|
|
|
437
431
|
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
|
|
438
432
|
This method makes a synchronous HTTP request by default. To make an
|
|
439
433
|
asynchronous HTTP request, please pass async_req=True
|
|
440
434
|
|
|
441
|
-
>>> thread = api.get_configuration_recipe_with_http_info(scope, code, as_at,
|
|
435
|
+
>>> thread = api.get_configuration_recipe_with_http_info(scope, code, as_at, async_req=True)
|
|
442
436
|
>>> result = thread.get()
|
|
443
437
|
|
|
444
438
|
:param scope: The scope of the Configuration Recipe to retrieve. (required)
|
|
@@ -447,12 +441,6 @@ class ConfigurationRecipeApi:
|
|
|
447
441
|
:type code: str
|
|
448
442
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
|
|
449
443
|
: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
|
|
456
444
|
:param async_req: Whether to execute the request asynchronously.
|
|
457
445
|
:type async_req: bool, optional
|
|
458
446
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -482,10 +470,7 @@ class ConfigurationRecipeApi:
|
|
|
482
470
|
_all_params = [
|
|
483
471
|
'scope',
|
|
484
472
|
'code',
|
|
485
|
-
'as_at'
|
|
486
|
-
'timeline_scope',
|
|
487
|
-
'timeline_code',
|
|
488
|
-
'closed_period_id'
|
|
473
|
+
'as_at'
|
|
489
474
|
]
|
|
490
475
|
_all_params.extend(
|
|
491
476
|
[
|
|
@@ -529,15 +514,6 @@ class ConfigurationRecipeApi:
|
|
|
529
514
|
else:
|
|
530
515
|
_query_params.append(('asAt', _params['as_at']))
|
|
531
516
|
|
|
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
|
-
|
|
541
517
|
# process the header parameters
|
|
542
518
|
_header_params = dict(_params.get('_headers', {}))
|
|
543
519
|
# process the form parameters
|
|
@@ -577,22 +553,22 @@ class ConfigurationRecipeApi:
|
|
|
577
553
|
|
|
578
554
|
|
|
579
555
|
@overload
|
|
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,
|
|
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
|
|
581
557
|
...
|
|
582
558
|
|
|
583
559
|
@overload
|
|
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,
|
|
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
|
|
585
561
|
...
|
|
586
562
|
|
|
587
563
|
@validate_arguments
|
|
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,
|
|
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
|
|
589
565
|
"""GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501
|
|
590
566
|
|
|
591
567
|
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
|
|
592
568
|
This method makes a synchronous HTTP request by default. To make an
|
|
593
569
|
asynchronous HTTP request, please pass async_req=True
|
|
594
570
|
|
|
595
|
-
>>> thread = api.get_derived_recipe(scope, code, as_at,
|
|
571
|
+
>>> thread = api.get_derived_recipe(scope, code, as_at, async_req=True)
|
|
596
572
|
>>> result = thread.get()
|
|
597
573
|
|
|
598
574
|
:param scope: The scope of the Configuration Recipe or Recipe Composer to return. (required)
|
|
@@ -601,12 +577,6 @@ class ConfigurationRecipeApi:
|
|
|
601
577
|
:type code: str
|
|
602
578
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
|
|
603
579
|
: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
|
|
610
580
|
:param async_req: Whether to execute the request asynchronously.
|
|
611
581
|
:type async_req: bool, optional
|
|
612
582
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -623,17 +593,17 @@ class ConfigurationRecipeApi:
|
|
|
623
593
|
raise ValueError(message)
|
|
624
594
|
if async_req is not None:
|
|
625
595
|
kwargs['async_req'] = async_req
|
|
626
|
-
return self.get_derived_recipe_with_http_info(scope, code, as_at,
|
|
596
|
+
return self.get_derived_recipe_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
627
597
|
|
|
628
598
|
@validate_arguments
|
|
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,
|
|
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
|
|
630
600
|
"""GetDerivedRecipe: Get Configuration Recipe either from the store or expanded from a Recipe Composer. # noqa: E501
|
|
631
601
|
|
|
632
602
|
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
|
|
633
603
|
This method makes a synchronous HTTP request by default. To make an
|
|
634
604
|
asynchronous HTTP request, please pass async_req=True
|
|
635
605
|
|
|
636
|
-
>>> thread = api.get_derived_recipe_with_http_info(scope, code, as_at,
|
|
606
|
+
>>> thread = api.get_derived_recipe_with_http_info(scope, code, as_at, async_req=True)
|
|
637
607
|
>>> result = thread.get()
|
|
638
608
|
|
|
639
609
|
:param scope: The scope of the Configuration Recipe or Recipe Composer to return. (required)
|
|
@@ -642,12 +612,6 @@ class ConfigurationRecipeApi:
|
|
|
642
612
|
:type code: str
|
|
643
613
|
:param as_at: The asAt datetime at which to retrieve the Configuration Recipe. Defaults to return the latest version if not specified.
|
|
644
614
|
: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
|
|
651
615
|
:param async_req: Whether to execute the request asynchronously.
|
|
652
616
|
:type async_req: bool, optional
|
|
653
617
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -677,10 +641,7 @@ class ConfigurationRecipeApi:
|
|
|
677
641
|
_all_params = [
|
|
678
642
|
'scope',
|
|
679
643
|
'code',
|
|
680
|
-
'as_at'
|
|
681
|
-
'timeline_scope',
|
|
682
|
-
'timeline_code',
|
|
683
|
-
'closed_period_id'
|
|
644
|
+
'as_at'
|
|
684
645
|
]
|
|
685
646
|
_all_params.extend(
|
|
686
647
|
[
|
|
@@ -724,15 +685,6 @@ class ConfigurationRecipeApi:
|
|
|
724
685
|
else:
|
|
725
686
|
_query_params.append(('asAt', _params['as_at']))
|
|
726
687
|
|
|
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
|
-
|
|
736
688
|
# process the header parameters
|
|
737
689
|
_header_params = dict(_params.get('_headers', {}))
|
|
738
690
|
# process the form parameters
|
|
@@ -772,22 +724,22 @@ class ConfigurationRecipeApi:
|
|
|
772
724
|
|
|
773
725
|
|
|
774
726
|
@overload
|
|
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,
|
|
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
|
|
776
728
|
...
|
|
777
729
|
|
|
778
730
|
@overload
|
|
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,
|
|
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
|
|
780
732
|
...
|
|
781
733
|
|
|
782
734
|
@validate_arguments
|
|
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,
|
|
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
|
|
784
736
|
"""GetRecipeComposer: Get Recipe Composer # noqa: E501
|
|
785
737
|
|
|
786
738
|
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
|
|
787
739
|
This method makes a synchronous HTTP request by default. To make an
|
|
788
740
|
asynchronous HTTP request, please pass async_req=True
|
|
789
741
|
|
|
790
|
-
>>> thread = api.get_recipe_composer(scope, code, as_at,
|
|
742
|
+
>>> thread = api.get_recipe_composer(scope, code, as_at, async_req=True)
|
|
791
743
|
>>> result = thread.get()
|
|
792
744
|
|
|
793
745
|
:param scope: The scope of the Recipe Composer to retrieve. (required)
|
|
@@ -796,12 +748,6 @@ class ConfigurationRecipeApi:
|
|
|
796
748
|
:type code: str
|
|
797
749
|
:param as_at: The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
|
|
798
750
|
: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
|
|
805
751
|
:param async_req: Whether to execute the request asynchronously.
|
|
806
752
|
:type async_req: bool, optional
|
|
807
753
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -818,17 +764,17 @@ class ConfigurationRecipeApi:
|
|
|
818
764
|
raise ValueError(message)
|
|
819
765
|
if async_req is not None:
|
|
820
766
|
kwargs['async_req'] = async_req
|
|
821
|
-
return self.get_recipe_composer_with_http_info(scope, code, as_at,
|
|
767
|
+
return self.get_recipe_composer_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
|
|
822
768
|
|
|
823
769
|
@validate_arguments
|
|
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,
|
|
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
|
|
825
771
|
"""GetRecipeComposer: Get Recipe Composer # noqa: E501
|
|
826
772
|
|
|
827
773
|
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
|
|
828
774
|
This method makes a synchronous HTTP request by default. To make an
|
|
829
775
|
asynchronous HTTP request, please pass async_req=True
|
|
830
776
|
|
|
831
|
-
>>> thread = api.get_recipe_composer_with_http_info(scope, code, as_at,
|
|
777
|
+
>>> thread = api.get_recipe_composer_with_http_info(scope, code, as_at, async_req=True)
|
|
832
778
|
>>> result = thread.get()
|
|
833
779
|
|
|
834
780
|
:param scope: The scope of the Recipe Composer to retrieve. (required)
|
|
@@ -837,12 +783,6 @@ class ConfigurationRecipeApi:
|
|
|
837
783
|
:type code: str
|
|
838
784
|
:param as_at: The asAt datetime at which to retrieve the Recipe Composer. Defaults to return the latest version if not specified.
|
|
839
785
|
: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
|
|
846
786
|
:param async_req: Whether to execute the request asynchronously.
|
|
847
787
|
:type async_req: bool, optional
|
|
848
788
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -872,10 +812,7 @@ class ConfigurationRecipeApi:
|
|
|
872
812
|
_all_params = [
|
|
873
813
|
'scope',
|
|
874
814
|
'code',
|
|
875
|
-
'as_at'
|
|
876
|
-
'timeline_scope',
|
|
877
|
-
'timeline_code',
|
|
878
|
-
'closed_period_id'
|
|
815
|
+
'as_at'
|
|
879
816
|
]
|
|
880
817
|
_all_params.extend(
|
|
881
818
|
[
|
|
@@ -919,15 +856,6 @@ class ConfigurationRecipeApi:
|
|
|
919
856
|
else:
|
|
920
857
|
_query_params.append(('asAt', _params['as_at']))
|
|
921
858
|
|
|
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
|
-
|
|
931
859
|
# process the header parameters
|
|
932
860
|
_header_params = dict(_params.get('_headers', {}))
|
|
933
861
|
# process the form parameters
|
|
@@ -1126,34 +1054,28 @@ class ConfigurationRecipeApi:
|
|
|
1126
1054
|
|
|
1127
1055
|
|
|
1128
1056
|
@overload
|
|
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,
|
|
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
|
|
1130
1058
|
...
|
|
1131
1059
|
|
|
1132
1060
|
@overload
|
|
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,
|
|
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
|
|
1134
1062
|
...
|
|
1135
1063
|
|
|
1136
1064
|
@validate_arguments
|
|
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,
|
|
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
|
|
1138
1066
|
"""ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
|
|
1139
1067
|
|
|
1140
1068
|
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
|
|
1141
1069
|
This method makes a synchronous HTTP request by default. To make an
|
|
1142
1070
|
asynchronous HTTP request, please pass async_req=True
|
|
1143
1071
|
|
|
1144
|
-
>>> thread = api.list_configuration_recipes(as_at, filter,
|
|
1072
|
+
>>> thread = api.list_configuration_recipes(as_at, filter, async_req=True)
|
|
1145
1073
|
>>> result = thread.get()
|
|
1146
1074
|
|
|
1147
1075
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1148
1076
|
:type as_at: datetime
|
|
1149
1077
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
1150
1078
|
: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
|
|
1157
1079
|
:param async_req: Whether to execute the request asynchronously.
|
|
1158
1080
|
:type async_req: bool, optional
|
|
1159
1081
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1170,29 +1092,23 @@ class ConfigurationRecipeApi:
|
|
|
1170
1092
|
raise ValueError(message)
|
|
1171
1093
|
if async_req is not None:
|
|
1172
1094
|
kwargs['async_req'] = async_req
|
|
1173
|
-
return self.list_configuration_recipes_with_http_info(as_at, filter,
|
|
1095
|
+
return self.list_configuration_recipes_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1174
1096
|
|
|
1175
1097
|
@validate_arguments
|
|
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,
|
|
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
|
|
1177
1099
|
"""ListConfigurationRecipes: List the set of Configuration Recipes # noqa: E501
|
|
1178
1100
|
|
|
1179
1101
|
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
|
|
1180
1102
|
This method makes a synchronous HTTP request by default. To make an
|
|
1181
1103
|
asynchronous HTTP request, please pass async_req=True
|
|
1182
1104
|
|
|
1183
|
-
>>> thread = api.list_configuration_recipes_with_http_info(as_at, filter,
|
|
1105
|
+
>>> thread = api.list_configuration_recipes_with_http_info(as_at, filter, async_req=True)
|
|
1184
1106
|
>>> result = thread.get()
|
|
1185
1107
|
|
|
1186
1108
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1187
1109
|
:type as_at: datetime
|
|
1188
1110
|
:param filter: Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
|
|
1189
1111
|
: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
|
|
1196
1112
|
:param async_req: Whether to execute the request asynchronously.
|
|
1197
1113
|
:type async_req: bool, optional
|
|
1198
1114
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1221,10 +1137,7 @@ class ConfigurationRecipeApi:
|
|
|
1221
1137
|
|
|
1222
1138
|
_all_params = [
|
|
1223
1139
|
'as_at',
|
|
1224
|
-
'filter'
|
|
1225
|
-
'timeline_scope',
|
|
1226
|
-
'timeline_code',
|
|
1227
|
-
'closed_period_id'
|
|
1140
|
+
'filter'
|
|
1228
1141
|
]
|
|
1229
1142
|
_all_params.extend(
|
|
1230
1143
|
[
|
|
@@ -1265,15 +1178,6 @@ class ConfigurationRecipeApi:
|
|
|
1265
1178
|
if _params.get('filter') is not None: # noqa: E501
|
|
1266
1179
|
_query_params.append(('filter', _params['filter']))
|
|
1267
1180
|
|
|
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
|
-
|
|
1277
1181
|
# process the header parameters
|
|
1278
1182
|
_header_params = dict(_params.get('_headers', {}))
|
|
1279
1183
|
# process the form parameters
|
|
@@ -1313,34 +1217,28 @@ class ConfigurationRecipeApi:
|
|
|
1313
1217
|
|
|
1314
1218
|
|
|
1315
1219
|
@overload
|
|
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,
|
|
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
|
|
1317
1221
|
...
|
|
1318
1222
|
|
|
1319
1223
|
@overload
|
|
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,
|
|
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
|
|
1321
1225
|
...
|
|
1322
1226
|
|
|
1323
1227
|
@validate_arguments
|
|
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,
|
|
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
|
|
1325
1229
|
"""ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501
|
|
1326
1230
|
|
|
1327
1231
|
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
|
|
1328
1232
|
This method makes a synchronous HTTP request by default. To make an
|
|
1329
1233
|
asynchronous HTTP request, please pass async_req=True
|
|
1330
1234
|
|
|
1331
|
-
>>> thread = api.list_derived_recipes(as_at, filter,
|
|
1235
|
+
>>> thread = api.list_derived_recipes(as_at, filter, async_req=True)
|
|
1332
1236
|
>>> result = thread.get()
|
|
1333
1237
|
|
|
1334
1238
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1335
1239
|
:type as_at: datetime
|
|
1336
1240
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1337
1241
|
: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
|
|
1344
1242
|
:param async_req: Whether to execute the request asynchronously.
|
|
1345
1243
|
:type async_req: bool, optional
|
|
1346
1244
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1357,29 +1255,23 @@ class ConfigurationRecipeApi:
|
|
|
1357
1255
|
raise ValueError(message)
|
|
1358
1256
|
if async_req is not None:
|
|
1359
1257
|
kwargs['async_req'] = async_req
|
|
1360
|
-
return self.list_derived_recipes_with_http_info(as_at, filter,
|
|
1258
|
+
return self.list_derived_recipes_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1361
1259
|
|
|
1362
1260
|
@validate_arguments
|
|
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,
|
|
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
|
|
1364
1262
|
"""ListDerivedRecipes: List the complete set of all Configuration Recipes, both from the configuration recipe store and also from expanded recipe composers. # noqa: E501
|
|
1365
1263
|
|
|
1366
1264
|
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
|
|
1367
1265
|
This method makes a synchronous HTTP request by default. To make an
|
|
1368
1266
|
asynchronous HTTP request, please pass async_req=True
|
|
1369
1267
|
|
|
1370
|
-
>>> thread = api.list_derived_recipes_with_http_info(as_at, filter,
|
|
1268
|
+
>>> thread = api.list_derived_recipes_with_http_info(as_at, filter, async_req=True)
|
|
1371
1269
|
>>> result = thread.get()
|
|
1372
1270
|
|
|
1373
1271
|
:param as_at: The asAt datetime at which to list the Configuration Recipes. Defaults to latest if not specified.
|
|
1374
1272
|
:type as_at: datetime
|
|
1375
1273
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1376
1274
|
: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
|
|
1383
1275
|
:param async_req: Whether to execute the request asynchronously.
|
|
1384
1276
|
:type async_req: bool, optional
|
|
1385
1277
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1408,10 +1300,7 @@ class ConfigurationRecipeApi:
|
|
|
1408
1300
|
|
|
1409
1301
|
_all_params = [
|
|
1410
1302
|
'as_at',
|
|
1411
|
-
'filter'
|
|
1412
|
-
'timeline_scope',
|
|
1413
|
-
'timeline_code',
|
|
1414
|
-
'closed_period_id'
|
|
1303
|
+
'filter'
|
|
1415
1304
|
]
|
|
1416
1305
|
_all_params.extend(
|
|
1417
1306
|
[
|
|
@@ -1452,15 +1341,6 @@ class ConfigurationRecipeApi:
|
|
|
1452
1341
|
if _params.get('filter') is not None: # noqa: E501
|
|
1453
1342
|
_query_params.append(('filter', _params['filter']))
|
|
1454
1343
|
|
|
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
|
-
|
|
1464
1344
|
# process the header parameters
|
|
1465
1345
|
_header_params = dict(_params.get('_headers', {}))
|
|
1466
1346
|
# process the form parameters
|
|
@@ -1500,34 +1380,28 @@ class ConfigurationRecipeApi:
|
|
|
1500
1380
|
|
|
1501
1381
|
|
|
1502
1382
|
@overload
|
|
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,
|
|
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
|
|
1504
1384
|
...
|
|
1505
1385
|
|
|
1506
1386
|
@overload
|
|
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,
|
|
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
|
|
1508
1388
|
...
|
|
1509
1389
|
|
|
1510
1390
|
@validate_arguments
|
|
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,
|
|
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
|
|
1512
1392
|
"""ListRecipeComposers: List the set of Recipe Composers # noqa: E501
|
|
1513
1393
|
|
|
1514
1394
|
List the set of Recipe Composers at the specified date/time and scope # noqa: E501
|
|
1515
1395
|
This method makes a synchronous HTTP request by default. To make an
|
|
1516
1396
|
asynchronous HTTP request, please pass async_req=True
|
|
1517
1397
|
|
|
1518
|
-
>>> thread = api.list_recipe_composers(as_at, filter,
|
|
1398
|
+
>>> thread = api.list_recipe_composers(as_at, filter, async_req=True)
|
|
1519
1399
|
>>> result = thread.get()
|
|
1520
1400
|
|
|
1521
1401
|
:param as_at: The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
|
|
1522
1402
|
:type as_at: datetime
|
|
1523
1403
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1524
1404
|
: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
|
|
1531
1405
|
:param async_req: Whether to execute the request asynchronously.
|
|
1532
1406
|
:type async_req: bool, optional
|
|
1533
1407
|
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
@@ -1544,29 +1418,23 @@ class ConfigurationRecipeApi:
|
|
|
1544
1418
|
raise ValueError(message)
|
|
1545
1419
|
if async_req is not None:
|
|
1546
1420
|
kwargs['async_req'] = async_req
|
|
1547
|
-
return self.list_recipe_composers_with_http_info(as_at, filter,
|
|
1421
|
+
return self.list_recipe_composers_with_http_info(as_at, filter, **kwargs) # noqa: E501
|
|
1548
1422
|
|
|
1549
1423
|
@validate_arguments
|
|
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,
|
|
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
|
|
1551
1425
|
"""ListRecipeComposers: List the set of Recipe Composers # noqa: E501
|
|
1552
1426
|
|
|
1553
1427
|
List the set of Recipe Composers at the specified date/time and scope # noqa: E501
|
|
1554
1428
|
This method makes a synchronous HTTP request by default. To make an
|
|
1555
1429
|
asynchronous HTTP request, please pass async_req=True
|
|
1556
1430
|
|
|
1557
|
-
>>> thread = api.list_recipe_composers_with_http_info(as_at, filter,
|
|
1431
|
+
>>> thread = api.list_recipe_composers_with_http_info(as_at, filter, async_req=True)
|
|
1558
1432
|
>>> result = thread.get()
|
|
1559
1433
|
|
|
1560
1434
|
:param as_at: The asAt datetime at which to list the Recipes Composers. Defaults to latest if not specified.
|
|
1561
1435
|
:type as_at: datetime
|
|
1562
1436
|
:param filter: Expression to filter the result set, note this functionality is not yet enabled for this endpoint.
|
|
1563
1437
|
: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
|
|
1570
1438
|
:param async_req: Whether to execute the request asynchronously.
|
|
1571
1439
|
:type async_req: bool, optional
|
|
1572
1440
|
:param _preload_content: if False, the ApiResponse.data will
|
|
@@ -1595,10 +1463,7 @@ class ConfigurationRecipeApi:
|
|
|
1595
1463
|
|
|
1596
1464
|
_all_params = [
|
|
1597
1465
|
'as_at',
|
|
1598
|
-
'filter'
|
|
1599
|
-
'timeline_scope',
|
|
1600
|
-
'timeline_code',
|
|
1601
|
-
'closed_period_id'
|
|
1466
|
+
'filter'
|
|
1602
1467
|
]
|
|
1603
1468
|
_all_params.extend(
|
|
1604
1469
|
[
|
|
@@ -1639,15 +1504,6 @@ class ConfigurationRecipeApi:
|
|
|
1639
1504
|
if _params.get('filter') is not None: # noqa: E501
|
|
1640
1505
|
_query_params.append(('filter', _params['filter']))
|
|
1641
1506
|
|
|
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
|
-
|
|
1651
1507
|
# process the header parameters
|
|
1652
1508
|
_header_params = dict(_params.get('_headers', {}))
|
|
1653
1509
|
# process the form parameters
|