lusid-sdk 2.1.741__py3-none-any.whl → 2.1.743__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 +6 -6
- lusid/api/instrument_event_types_api.py +14 -14
- lusid/api/instrument_events_api.py +8 -8
- lusid/api/instruments_api.py +16 -16
- lusid/api/order_instructions_api.py +8 -8
- lusid/api/staged_modifications_api.py +8 -8
- lusid/api/staging_rule_set_api.py +10 -10
- lusid/api/structured_result_data_api.py +12 -12
- lusid/api/transaction_fees_api.py +10 -10
- lusid/api/transaction_portfolios_api.py +32 -32
- lusid/configuration.py +1 -1
- {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/METADATA +63 -63
- {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/RECORD +14 -14
- {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/WHEEL +0 -0
@@ -67,7 +67,7 @@ class StagedModificationsApi:
|
|
67
67
|
|
68
68
|
@validate_arguments
|
69
69
|
def add_decision(self, id : Annotated[StrictStr, Field(..., description="Unique Id for a staged modification..")], staged_modification_decision_request : Annotated[StagedModificationDecisionRequest, Field(..., description="The decision on the requested staged modification, \"Approve\" or \"Reject\".")], async_req: Optional[bool]=None, **kwargs) -> Union[StagedModification, Awaitable[StagedModification]]: # noqa: E501
|
70
|
-
"""
|
70
|
+
"""AddDecision: AddDecision # noqa: E501
|
71
71
|
|
72
72
|
Add decision to staged modification, Approve or Reject. # noqa: E501
|
73
73
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -100,7 +100,7 @@ class StagedModificationsApi:
|
|
100
100
|
|
101
101
|
@validate_arguments
|
102
102
|
def add_decision_with_http_info(self, id : Annotated[StrictStr, Field(..., description="Unique Id for a staged modification..")], staged_modification_decision_request : Annotated[StagedModificationDecisionRequest, Field(..., description="The decision on the requested staged modification, \"Approve\" or \"Reject\".")], **kwargs) -> ApiResponse: # noqa: E501
|
103
|
-
"""
|
103
|
+
"""AddDecision: AddDecision # noqa: E501
|
104
104
|
|
105
105
|
Add decision to staged modification, Approve or Reject. # noqa: E501
|
106
106
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -234,7 +234,7 @@ class StagedModificationsApi:
|
|
234
234
|
|
235
235
|
@validate_arguments
|
236
236
|
def get_staged_modification(self, id : Annotated[StrictStr, Field(..., description="The unique identifier for a staged modification.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[StagedModification, Awaitable[StagedModification]]: # noqa: E501
|
237
|
-
"""
|
237
|
+
"""GetStagedModification: GetStagedModification # noqa: E501
|
238
238
|
|
239
239
|
Retrieve the details of a staged modification. # noqa: E501
|
240
240
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -267,7 +267,7 @@ class StagedModificationsApi:
|
|
267
267
|
|
268
268
|
@validate_arguments
|
269
269
|
def get_staged_modification_with_http_info(self, id : Annotated[StrictStr, Field(..., description="The unique identifier for a staged modification.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staged modification. Defaults to latest if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
270
|
-
"""
|
270
|
+
"""GetStagedModification: GetStagedModification # noqa: E501
|
271
271
|
|
272
272
|
Retrieve the details of a staged modification. # noqa: E501
|
273
273
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -397,7 +397,7 @@ class StagedModificationsApi:
|
|
397
397
|
|
398
398
|
@validate_arguments
|
399
399
|
def list_requested_changes(self, id : Annotated[StrictStr, Field(..., description="Unique Id for a staged modification..")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfStagedModificationsRequestedChangeInterval, Awaitable[PagedResourceListOfStagedModificationsRequestedChangeInterval]]: # noqa: E501
|
400
|
-
"""
|
400
|
+
"""ListRequestedChanges: ListRequestedChanges # noqa: E501
|
401
401
|
|
402
402
|
List the requested changes for a staged modification. # noqa: E501
|
403
403
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -438,7 +438,7 @@ class StagedModificationsApi:
|
|
438
438
|
|
439
439
|
@validate_arguments
|
440
440
|
def list_requested_changes_with_http_info(self, id : Annotated[StrictStr, Field(..., description="Unique Id for a staged modification..")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list changes. Defaults to return the latest version of each staged change if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing requested staged modification changes from a previous call to list requested staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
441
|
-
"""
|
441
|
+
"""ListRequestedChanges: ListRequestedChanges # noqa: E501
|
442
442
|
|
443
443
|
List the requested changes for a staged modification. # noqa: E501
|
444
444
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -593,7 +593,7 @@ class StagedModificationsApi:
|
|
593
593
|
|
594
594
|
@validate_arguments
|
595
595
|
def list_staged_modifications(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfStagedModification, Awaitable[PagedResourceListOfStagedModification]]: # noqa: E501
|
596
|
-
"""
|
596
|
+
"""ListStagedModifications: ListStagedModifications # noqa: E501
|
597
597
|
|
598
598
|
List summaries of the staged modifications. # noqa: E501
|
599
599
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -632,7 +632,7 @@ class StagedModificationsApi:
|
|
632
632
|
|
633
633
|
@validate_arguments
|
634
634
|
def list_staged_modifications_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list staged modifications. Defaults to return the latest version of each staged modification if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing staged modifications from a previous call to list staged modifications. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many. Defaults to 100 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
635
|
-
"""
|
635
|
+
"""ListStagedModifications: ListStagedModifications # noqa: E501
|
636
636
|
|
637
637
|
List summaries of the staged modifications. # noqa: E501
|
638
638
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -68,7 +68,7 @@ class StagingRuleSetApi:
|
|
68
68
|
|
69
69
|
@validate_arguments
|
70
70
|
def create_staging_rule_set(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to create the staging rule set.")], create_staging_rule_set_request : Annotated[CreateStagingRuleSetRequest, Field(..., description="Request to create a staging rule set.")], async_req: Optional[bool]=None, **kwargs) -> Union[StagingRuleSet, Awaitable[StagingRuleSet]]: # noqa: E501
|
71
|
-
"""
|
71
|
+
"""CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
|
72
72
|
|
73
73
|
Create a new staging rule set. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -101,7 +101,7 @@ class StagingRuleSetApi:
|
|
101
101
|
|
102
102
|
@validate_arguments
|
103
103
|
def create_staging_rule_set_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to create the staging rule set.")], create_staging_rule_set_request : Annotated[CreateStagingRuleSetRequest, Field(..., description="Request to create a staging rule set.")], **kwargs) -> ApiResponse: # noqa: E501
|
104
|
-
"""
|
104
|
+
"""CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
|
105
105
|
|
106
106
|
Create a new staging rule set. # noqa: E501
|
107
107
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -235,7 +235,7 @@ class StagingRuleSetApi:
|
|
235
235
|
|
236
236
|
@validate_arguments
|
237
237
|
def delete_staging_rule_set(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to delete the staging rule set.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
238
|
-
"""
|
238
|
+
"""DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
|
239
239
|
|
240
240
|
Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set's creation datetime. This means that the staging rule set will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
241
241
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -266,7 +266,7 @@ class StagingRuleSetApi:
|
|
266
266
|
|
267
267
|
@validate_arguments
|
268
268
|
def delete_staging_rule_set_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to delete the staging rule set.")], **kwargs) -> ApiResponse: # noqa: E501
|
269
|
-
"""
|
269
|
+
"""DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
|
270
270
|
|
271
271
|
Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set's creation datetime. This means that the staging rule set will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
|
272
272
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -387,7 +387,7 @@ class StagingRuleSetApi:
|
|
387
387
|
|
388
388
|
@validate_arguments
|
389
389
|
def get_staging_rule_set(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to retrieve the staging rule set.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staging rule set. Defaults to return the latest version of the staging rule set if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[StagingRuleSet, Awaitable[StagingRuleSet]]: # noqa: E501
|
390
|
-
"""
|
390
|
+
"""GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
|
391
391
|
|
392
392
|
Get the staging rule set for the given entity type at the specific asAt time. # noqa: E501
|
393
393
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -420,7 +420,7 @@ class StagingRuleSetApi:
|
|
420
420
|
|
421
421
|
@validate_arguments
|
422
422
|
def get_staging_rule_set_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to retrieve the staging rule set.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staging rule set. Defaults to return the latest version of the staging rule set if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
423
|
-
"""
|
423
|
+
"""GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
|
424
424
|
|
425
425
|
Get the staging rule set for the given entity type at the specific asAt time. # noqa: E501
|
426
426
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -550,7 +550,7 @@ class StagingRuleSetApi:
|
|
550
550
|
|
551
551
|
@validate_arguments
|
552
552
|
def list_staging_rule_sets(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staging rule sets. Defaults to return the latest version of the staging rule sets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing staging rule sets from a previous call to list staging rule sets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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[PagedResourceListOfStagingRuleSet, Awaitable[PagedResourceListOfStagingRuleSet]]: # noqa: E501
|
553
|
-
"""
|
553
|
+
"""ListStagingRuleSets: List StagingRuleSets # noqa: E501
|
554
554
|
|
555
555
|
List all the staging rule sets matching particular criteria. # noqa: E501
|
556
556
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -589,7 +589,7 @@ class StagingRuleSetApi:
|
|
589
589
|
|
590
590
|
@validate_arguments
|
591
591
|
def list_staging_rule_sets_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the staging rule sets. Defaults to return the latest version of the staging rule sets if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing staging rule sets from a previous call to list staging rule sets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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
|
592
|
-
"""
|
592
|
+
"""ListStagingRuleSets: List StagingRuleSets # noqa: E501
|
593
593
|
|
594
594
|
List all the staging rule sets matching particular criteria. # noqa: E501
|
595
595
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -738,7 +738,7 @@ class StagingRuleSetApi:
|
|
738
738
|
|
739
739
|
@validate_arguments
|
740
740
|
def update_staging_rule_set(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to update the staging rule set.")], update_staging_rule_set_request : Annotated[UpdateStagingRuleSetRequest, Field(..., description="Request to update a staging rule set.")], async_req: Optional[bool]=None, **kwargs) -> Union[StagingRuleSet, Awaitable[StagingRuleSet]]: # noqa: E501
|
741
|
-
"""
|
741
|
+
"""UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
|
742
742
|
|
743
743
|
Update an existing staging rule set. # noqa: E501
|
744
744
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -771,7 +771,7 @@ class StagingRuleSetApi:
|
|
771
771
|
|
772
772
|
@validate_arguments
|
773
773
|
def update_staging_rule_set_with_http_info(self, entity_type : Annotated[StrictStr, Field(..., description="The entity type for which to update the staging rule set.")], update_staging_rule_set_request : Annotated[UpdateStagingRuleSetRequest, Field(..., description="Request to update a staging rule set.")], **kwargs) -> ApiResponse: # noqa: E501
|
774
|
-
"""
|
774
|
+
"""UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
|
775
775
|
|
776
776
|
Update an existing staging rule set. # noqa: E501
|
777
777
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -242,7 +242,7 @@ class StructuredResultDataApi:
|
|
242
242
|
|
243
243
|
@validate_arguments
|
244
244
|
def delete_structured_result_data(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to delete data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The data IDs to delete, each keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[AnnulStructuredDataResponse, Awaitable[AnnulStructuredDataResponse]]: # noqa: E501
|
245
|
-
"""
|
245
|
+
"""DeleteStructuredResultData: Delete structured result data # noqa: E501
|
246
246
|
|
247
247
|
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
248
248
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -275,7 +275,7 @@ class StructuredResultDataApi:
|
|
275
275
|
|
276
276
|
@validate_arguments
|
277
277
|
def delete_structured_result_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to delete data items.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The data IDs to delete, each keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
278
|
-
"""
|
278
|
+
"""DeleteStructuredResultData: Delete structured result data # noqa: E501
|
279
279
|
|
280
280
|
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
281
281
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -409,7 +409,7 @@ class StructuredResultDataApi:
|
|
409
409
|
|
410
410
|
@validate_arguments
|
411
411
|
def get_address_key_definitions_for_document(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfAddressKeyDefinition, Awaitable[ResourceListOfAddressKeyDefinition]]: # noqa: E501
|
412
|
-
"""
|
412
|
+
"""GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
|
413
413
|
|
414
414
|
For a given virtual document retrieve all the address key definitions that are in use. # noqa: E501
|
415
415
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -450,7 +450,7 @@ class StructuredResultDataApi:
|
|
450
450
|
|
451
451
|
@validate_arguments
|
452
452
|
def get_address_key_definitions_for_document_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the document for which address key definitions are retrieved.")], code : Annotated[StrictStr, Field(..., description="The code of the document for which address key definitions are retrieved.")], source : Annotated[StrictStr, Field(..., description="The source of the document for which address key definitions are retrieved.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the document for which address key definitions are retrieved.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
453
|
-
"""
|
453
|
+
"""GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
|
454
454
|
|
455
455
|
For a given virtual document retrieve all the address key definitions that are in use. # noqa: E501
|
456
456
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -604,7 +604,7 @@ class StructuredResultDataApi:
|
|
604
604
|
|
605
605
|
@validate_arguments
|
606
606
|
def get_data_map(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data maps.")], request_body : Annotated[Dict[str, DataMapKey], Field(..., description="The data map keys to look up, each keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[GetDataMapResponse, Awaitable[GetDataMapResponse]]: # noqa: E501
|
607
|
-
"""
|
607
|
+
"""GetDataMap: Get data map # noqa: E501
|
608
608
|
|
609
609
|
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
610
610
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -637,7 +637,7 @@ class StructuredResultDataApi:
|
|
637
637
|
|
638
638
|
@validate_arguments
|
639
639
|
def get_data_map_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope from which to retrieve data maps.")], request_body : Annotated[Dict[str, DataMapKey], Field(..., description="The data map keys to look up, each keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
640
|
-
"""
|
640
|
+
"""GetDataMap: Get data map # noqa: E501
|
641
641
|
|
642
642
|
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
643
643
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -957,7 +957,7 @@ class StructuredResultDataApi:
|
|
957
957
|
|
958
958
|
@validate_arguments
|
959
959
|
def get_virtual_document(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetVirtualDocumentResponse, Awaitable[GetVirtualDocumentResponse]]: # noqa: E501
|
960
|
-
"""
|
960
|
+
"""GetVirtualDocument: Get Virtual Documents # noqa: E501
|
961
961
|
|
962
962
|
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
963
963
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -992,7 +992,7 @@ class StructuredResultDataApi:
|
|
992
992
|
|
993
993
|
@validate_arguments
|
994
994
|
def get_virtual_document_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, StructuredResultDataId], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
995
|
-
"""
|
995
|
+
"""GetVirtualDocument: Get Virtual Documents # noqa: E501
|
996
996
|
|
997
997
|
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # noqa: E501
|
998
998
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -1135,7 +1135,7 @@ class StructuredResultDataApi:
|
|
1135
1135
|
|
1136
1136
|
@validate_arguments
|
1137
1137
|
def get_virtual_document_rows(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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[PagedResourceListOfVirtualRow, Awaitable[PagedResourceListOfVirtualRow]]: # noqa: E501
|
1138
|
-
"""
|
1138
|
+
"""GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
|
1139
1139
|
|
1140
1140
|
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # noqa: E501
|
1141
1141
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -1182,7 +1182,7 @@ class StructuredResultDataApi:
|
|
1182
1182
|
|
1183
1183
|
@validate_arguments
|
1184
1184
|
def get_virtual_document_rows_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to retrieve the virtual document.")], code : Annotated[StrictStr, Field(..., description="The code of the virtual document to retrieve.")], source : Annotated[StrictStr, Field(..., description="The source of the virtual document to retrieve.")], result_type : Annotated[StrictStr, Field(..., description="The result type of the virtual document to retrieve.")], effective_at : Annotated[StrictStr, Field(..., description="The effectiveAt datetime at which to retrieve the virtual document.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the number of returned results to this many.")] = 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
|
1185
|
-
"""
|
1185
|
+
"""GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
|
1186
1186
|
|
1187
1187
|
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # noqa: E501
|
1188
1188
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -1354,7 +1354,7 @@ class StructuredResultDataApi:
|
|
1354
1354
|
|
1355
1355
|
@validate_arguments
|
1356
1356
|
def upsert_result_value(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, UpsertResultValuesDataRequest], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertStructuredDataResponse, Awaitable[UpsertStructuredDataResponse]]: # noqa: E501
|
1357
|
-
"""
|
1357
|
+
"""UpsertResultValue: Upsert result value # noqa: E501
|
1358
1358
|
|
1359
1359
|
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1360
1360
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -1387,7 +1387,7 @@ class StructuredResultDataApi:
|
|
1387
1387
|
|
1388
1388
|
@validate_arguments
|
1389
1389
|
def upsert_result_value_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope in which to construct the virtual documents.")], request_body : Annotated[Dict[str, UpsertResultValuesDataRequest], Field(..., description="The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.")], **kwargs) -> ApiResponse: # noqa: E501
|
1390
|
-
"""
|
1390
|
+
"""UpsertResultValue: Upsert result value # noqa: E501
|
1391
1391
|
|
1392
1392
|
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # noqa: E501
|
1393
1393
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -68,7 +68,7 @@ class TransactionFeesApi:
|
|
68
68
|
|
69
69
|
@validate_arguments
|
70
70
|
def delete_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
|
71
|
-
"""
|
71
|
+
"""DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501
|
72
72
|
|
73
73
|
Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone. # noqa: E501
|
74
74
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -99,7 +99,7 @@ class TransactionFeesApi:
|
|
99
99
|
|
100
100
|
@validate_arguments
|
101
101
|
def delete_transaction_fee_rule_with_http_info(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], **kwargs) -> ApiResponse: # noqa: E501
|
102
|
-
"""
|
102
|
+
"""DeleteTransactionFeeRule: Deletes a fee rule. # noqa: E501
|
103
103
|
|
104
104
|
Deletes the rule for all effective time. The rule will remain viewable at previous as at times, but it will no longer be considered by GetApplicableFees. This cannot be undone. # noqa: E501
|
105
105
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -220,7 +220,7 @@ class TransactionFeesApi:
|
|
220
220
|
|
221
221
|
@validate_arguments
|
222
222
|
def get_applicable_transaction_fees(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfFeeRule, Awaitable[ResourceListOfFeeRule]]: # noqa: E501
|
223
|
-
"""
|
223
|
+
"""GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. # noqa: E501
|
224
224
|
|
225
225
|
Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501
|
226
226
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -263,7 +263,7 @@ class TransactionFeesApi:
|
|
263
263
|
|
264
264
|
@validate_arguments
|
265
265
|
def get_applicable_transaction_fees_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to match rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to match rule definitions. Defaults to returning the latest version if not specified.")] = None, instrument_identifier_type : Annotated[Optional[StrictStr], Field( description="Optional. The unique identifier type to use, eg 'Figi' or 'LusidInstrumentId'.")] = None, instrument_identifier : Annotated[Optional[StrictStr], Field( description="Optional. The Instrument Identifier to get properties for.")] = None, portfolio_scope : Annotated[Optional[StrictStr], Field( description="Optional. The scope of the portfolio to fetch properties from.")] = None, portfolio_code : Annotated[Optional[StrictStr], Field( description="Optional. The code of the portfolio to fetch properties from.")] = None, request_body : Annotated[Optional[Dict[str, StrictStr]], Field(description="Any other property keys or fields, including the top-level fields of the fee rule (e.g. \"ExecutionBroker\" and \"SettlementCurrency\" ) and those defined in AdditionalKeys, along with their corresponding values that should be matched for fees. Eg. \"Instrument/default/Name=exampleValue\" or \"AdditionalKey2=Value2\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
266
|
-
"""
|
266
|
+
"""GetApplicableTransactionFees: Get the Fees and Commissions that may be applicable to a transaction. # noqa: E501
|
267
267
|
|
268
268
|
Additionally, matching can be based on the instrument's properties, its portfolio properties, and any additional property keys present in the data file. # noqa: E501
|
269
269
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -430,7 +430,7 @@ class TransactionFeesApi:
|
|
430
430
|
|
431
431
|
@validate_arguments
|
432
432
|
def get_transaction_fee_rule(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[FeeRule, Awaitable[FeeRule]]: # noqa: E501
|
433
|
-
"""
|
433
|
+
"""GetTransactionFeeRule: Retrieve the definition of single fee rule. # noqa: E501
|
434
434
|
|
435
435
|
Retrieves the fee rule definition at the given effective and as at times. # noqa: E501
|
436
436
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -465,7 +465,7 @@ class TransactionFeesApi:
|
|
465
465
|
|
466
466
|
@validate_arguments
|
467
467
|
def get_transaction_fee_rule_with_http_info(self, code : Annotated[StrictStr, Field(..., description="The fee rule code.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
468
|
-
"""
|
468
|
+
"""GetTransactionFeeRule: Retrieve the definition of single fee rule. # noqa: E501
|
469
469
|
|
470
470
|
Retrieves the fee rule definition at the given effective and as at times. # noqa: E501
|
471
471
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -601,7 +601,7 @@ class TransactionFeesApi:
|
|
601
601
|
|
602
602
|
@validate_arguments
|
603
603
|
def list_transaction_fee_rules(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfFeeRule, Awaitable[ResourceListOfFeeRule]]: # noqa: E501
|
604
|
-
"""
|
604
|
+
"""ListTransactionFeeRules: List fee rules, with optional filtering. # noqa: E501
|
605
605
|
|
606
606
|
For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501
|
607
607
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -640,7 +640,7 @@ class TransactionFeesApi:
|
|
640
640
|
|
641
641
|
@validate_arguments
|
642
642
|
def list_transaction_fee_rules_with_http_info(self, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results to this number. Defaults to 100 if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the results.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
643
|
-
"""
|
643
|
+
"""ListTransactionFeeRules: List fee rules, with optional filtering. # noqa: E501
|
644
644
|
|
645
645
|
For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. # noqa: E501
|
646
646
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -788,7 +788,7 @@ class TransactionFeesApi:
|
|
788
788
|
|
789
789
|
@validate_arguments
|
790
790
|
def upsert_transaction_fee_rules(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[FeeRuleUpsertResponse, Awaitable[FeeRuleUpsertResponse]]: # noqa: E501
|
791
|
-
"""
|
791
|
+
"""UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501
|
792
792
|
|
793
793
|
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. # noqa: E501
|
794
794
|
This method makes a synchronous HTTP request by default. To make an
|
@@ -821,7 +821,7 @@ class TransactionFeesApi:
|
|
821
821
|
|
822
822
|
@validate_arguments
|
823
823
|
def upsert_transaction_fee_rules_with_http_info(self, request_body : Annotated[Dict[str, FeeRuleUpsertRequest], Field(..., description="A dictionary of upsert request identifiers to rule upsert requests. The request identifiers are valid for the request only and can be used to link the upserted fee rule to the code of a created fee rule.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which the rule will take effect. Defaults to the current LUSID system datetime if not specified. In the case of an update, the changes will take place from this effective time until the next effective time that the rule as been upserted at. For example, consider a rule that already exists, and has previously had an update applied so that the definition will change on the first day of the coming month. An upsert effective from the current day will only change the definition until the first day of the coming month. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
824
|
-
"""
|
824
|
+
"""UpsertTransactionFeeRules: Upsert fee rules. # noqa: E501
|
825
825
|
|
826
826
|
To upsert a new rule, the code field must be left empty, a code will then be assigned and returned as part of the response. To update an existing rule, include the fee code. It is possible to both create and update fee rules in the same request. The upsert is transactional - either all create/update operations will succeed or none of them will. # noqa: E501
|
827
827
|
This method makes a synchronous HTTP request by default. To make an
|