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.
Files changed (14) hide show
  1. lusid/api/complex_market_data_api.py +6 -6
  2. lusid/api/instrument_event_types_api.py +14 -14
  3. lusid/api/instrument_events_api.py +8 -8
  4. lusid/api/instruments_api.py +16 -16
  5. lusid/api/order_instructions_api.py +8 -8
  6. lusid/api/staged_modifications_api.py +8 -8
  7. lusid/api/staging_rule_set_api.py +10 -10
  8. lusid/api/structured_result_data_api.py +12 -12
  9. lusid/api/transaction_fees_api.py +10 -10
  10. lusid/api/transaction_portfolios_api.py +32 -32
  11. lusid/configuration.py +1 -1
  12. {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/METADATA +63 -63
  13. {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/RECORD +14 -14
  14. {lusid_sdk-2.1.741.dist-info → lusid_sdk-2.1.743.dist-info}/WHEEL +0 -0
lusid/api/complex_market_data_api.py CHANGED
@@ -69,7 +69,7 @@ class ComplexMarketDataApi:
69
69
 
70
70
  @validate_arguments
71
71
  def delete_complex_market_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the complex market data to delete.")], request_body : Annotated[Dict[str, ComplexMarketDataId], Field(..., description="The complex market data Ids to delete, each keyed by a unique correlation id.")], async_req: Optional[bool]=None, **kwargs) -> Union[AnnulStructuredDataResponse, Awaitable[AnnulStructuredDataResponse]]: # noqa: E501
72
- """[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
72
+ """DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
73
73
 
74
74
  Delete one or more specified complex market data items from a single 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 complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. # noqa: E501
75
75
  This method makes a synchronous HTTP request by default. To make an
@@ -102,7 +102,7 @@ class ComplexMarketDataApi:
102
102
 
103
103
  @validate_arguments
104
104
  def delete_complex_market_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the complex market data to delete.")], request_body : Annotated[Dict[str, ComplexMarketDataId], Field(..., description="The complex market data Ids to delete, each keyed by a unique correlation id.")], **kwargs) -> ApiResponse: # noqa: E501
105
- """[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
105
+ """DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. # noqa: E501
106
106
 
107
107
  Delete one or more specified complex market data items from a single 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 complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. # noqa: E501
108
108
  This method makes a synchronous HTTP request by default. To make an
@@ -236,7 +236,7 @@ class ComplexMarketDataApi:
236
236
 
237
237
  @validate_arguments
238
238
  def get_complex_market_data(self, scope : Annotated[StrictStr, Field(..., description="The scope of the complex market data to retrieve.")], request_body : Annotated[Dict[str, ComplexMarketDataId], Field(..., description="The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetComplexMarketDataResponse, Awaitable[GetComplexMarketDataResponse]]: # noqa: E501
239
- """[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
239
+ """GetComplexMarketData: Get complex market data # noqa: E501
240
240
 
241
241
  Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, 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 will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. # noqa: E501
242
242
  This method makes a synchronous HTTP request by default. To make an
@@ -275,7 +275,7 @@ class ComplexMarketDataApi:
275
275
 
276
276
  @validate_arguments
277
277
  def get_complex_market_data_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the complex market data to retrieve.")], request_body : Annotated[Dict[str, ComplexMarketDataId], Field(..., description="The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified.")] = None, max_age : Annotated[Optional[StrictStr], Field( description="The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved.")] = None, **kwargs) -> ApiResponse: # noqa: E501
278
- """[EARLY ACCESS] GetComplexMarketData: Get complex market data # noqa: E501
278
+ """GetComplexMarketData: Get complex market data # noqa: E501
279
279
 
280
280
  Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, 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 will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. # noqa: E501
281
281
  This method makes a synchronous HTTP request by default. To make an
@@ -430,7 +430,7 @@ class ComplexMarketDataApi:
430
430
 
431
431
  @validate_arguments
432
432
  def list_complex_market_data(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfListComplexMarketDataWithMetaDataResponse, Awaitable[ResourceListOfListComplexMarketDataWithMetaDataResponse]]: # noqa: E501
433
- """[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
433
+ """ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
434
434
 
435
435
  List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. # noqa: E501
436
436
  This method makes a synchronous HTTP request by default. To make an
@@ -461,7 +461,7 @@ class ComplexMarketDataApi:
461
461
 
462
462
  @validate_arguments
463
463
  def list_complex_market_data_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
464
- """[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
464
+ """ListComplexMarketData: List the set of ComplexMarketData # noqa: E501
465
465
 
466
466
  List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. # noqa: E501
467
467
  This method makes a synchronous HTTP request by default. To make an
lusid/api/instrument_event_types_api.py CHANGED
@@ -68,7 +68,7 @@ class InstrumentEventTypesApi:
68
68
 
69
69
  @validate_arguments
70
70
  def create_transaction_template(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies.")], transaction_template_request : Annotated[TransactionTemplateRequest, Field(..., description="A request defining a new transaction template to be created.")], async_req: Optional[bool]=None, **kwargs) -> Union[TransactionTemplate, Awaitable[TransactionTemplate]]: # noqa: E501
71
- """[EARLY ACCESS] CreateTransactionTemplate: Create Transaction Template # noqa: E501
71
+ """CreateTransactionTemplate: Create Transaction Template # noqa: E501
72
72
 
73
73
  Create a transaction template for a particular instrument event type in a scope. # noqa: E501
74
74
  This method makes a synchronous HTTP request by default. To make an
@@ -105,7 +105,7 @@ class InstrumentEventTypesApi:
105
105
 
106
106
  @validate_arguments
107
107
  def create_transaction_template_with_http_info(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies.")], transaction_template_request : Annotated[TransactionTemplateRequest, Field(..., description="A request defining a new transaction template to be created.")], **kwargs) -> ApiResponse: # noqa: E501
108
- """[EARLY ACCESS] CreateTransactionTemplate: Create Transaction Template # noqa: E501
108
+ """CreateTransactionTemplate: Create Transaction Template # noqa: E501
109
109
 
110
110
  Create a transaction template for a particular instrument event type in a scope. # noqa: E501
111
111
  This method makes a synchronous HTTP request by default. To make an
@@ -251,7 +251,7 @@ class InstrumentEventTypesApi:
251
251
 
252
252
  @validate_arguments
253
253
  def delete_transaction_template(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope of the template.")], async_req: Optional[bool]=None, **kwargs) -> Union[datetime, Awaitable[datetime]]: # noqa: E501
254
- """[EARLY ACCESS] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
254
+ """DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
255
255
 
256
256
  Delete a transaction template for a particular instrument event type in a scope. # noqa: E501
257
257
  This method makes a synchronous HTTP request by default. To make an
@@ -286,7 +286,7 @@ class InstrumentEventTypesApi:
286
286
 
287
287
  @validate_arguments
288
288
  def delete_transaction_template_with_http_info(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope of the template.")], **kwargs) -> ApiResponse: # noqa: E501
289
- """[EARLY ACCESS] DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
289
+ """DeleteTransactionTemplate: Delete Transaction Template # noqa: E501
290
290
 
291
291
  Delete a transaction template for a particular instrument event type in a scope. # noqa: E501
292
292
  This method makes a synchronous HTTP request by default. To make an
@@ -419,7 +419,7 @@ class InstrumentEventTypesApi:
419
419
 
420
420
  @validate_arguments
421
421
  def get_transaction_template(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The instrument event type of the transaction template")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies. When not supplied the scope is 'default'.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt time of the requested Transaction Template")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionTemplate, Awaitable[TransactionTemplate]]: # noqa: E501
422
- """[EARLY ACCESS] GetTransactionTemplate: Get Transaction Template # noqa: E501
422
+ """GetTransactionTemplate: Get Transaction Template # noqa: E501
423
423
 
424
424
  Gets the Transaction Template that for the instrument event type within the scope specified. # noqa: E501
425
425
  This method makes a synchronous HTTP request by default. To make an
@@ -456,7 +456,7 @@ class InstrumentEventTypesApi:
456
456
 
457
457
  @validate_arguments
458
458
  def get_transaction_template_with_http_info(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The instrument event type of the transaction template")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies. When not supplied the scope is 'default'.")], as_at : Annotated[Optional[datetime], Field(description="The AsAt time of the requested Transaction Template")] = None, **kwargs) -> ApiResponse: # noqa: E501
459
- """[EARLY ACCESS] GetTransactionTemplate: Get Transaction Template # noqa: E501
459
+ """GetTransactionTemplate: Get Transaction Template # noqa: E501
460
460
 
461
461
  Gets the Transaction Template that for the instrument event type within the scope specified. # noqa: E501
462
462
  This method makes a synchronous HTTP request by default. To make an
@@ -598,7 +598,7 @@ class InstrumentEventTypesApi:
598
598
 
599
599
  @validate_arguments
600
600
  def get_transaction_template_specification(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The requested instrument event type.")], async_req: Optional[bool]=None, **kwargs) -> Union[TransactionTemplateSpecification, Awaitable[TransactionTemplateSpecification]]: # noqa: E501
601
- """[EARLY ACCESS] GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
601
+ """GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
602
602
 
603
603
  Retrieve the transaction template specification for a particular event type. # noqa: E501
604
604
  This method makes a synchronous HTTP request by default. To make an
@@ -629,7 +629,7 @@ class InstrumentEventTypesApi:
629
629
 
630
630
  @validate_arguments
631
631
  def get_transaction_template_specification_with_http_info(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The requested instrument event type.")], **kwargs) -> ApiResponse: # noqa: E501
632
- """[EARLY ACCESS] GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
632
+ """GetTransactionTemplateSpecification: Get Transaction Template Specification. # noqa: E501
633
633
 
634
634
  Retrieve the transaction template specification for a particular event type. # noqa: E501
635
635
  This method makes a synchronous HTTP request by default. To make an
@@ -750,7 +750,7 @@ class InstrumentEventTypesApi:
750
750
 
751
751
  @validate_arguments
752
752
  def list_transaction_template_specifications(self, as_at : Annotated[Optional[datetime], Field(description="AsAt of the request")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfTransactionTemplateSpecification, Awaitable[PagedResourceListOfTransactionTemplateSpecification]]: # noqa: E501
753
- """[EARLY ACCESS] ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
753
+ """ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
754
754
 
755
755
  Retrieves all transaction template specifications. # noqa: E501
756
756
  This method makes a synchronous HTTP request by default. To make an
@@ -789,7 +789,7 @@ class InstrumentEventTypesApi:
789
789
 
790
790
  @validate_arguments
791
791
  def list_transaction_template_specifications_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="AsAt of the request")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
792
- """[EARLY ACCESS] ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
792
+ """ListTransactionTemplateSpecifications: List Transaction Template Specifications. # noqa: E501
793
793
 
794
794
  Retrieves all transaction template specifications. # noqa: E501
795
795
  This method makes a synchronous HTTP request by default. To make an
@@ -938,7 +938,7 @@ class InstrumentEventTypesApi:
938
938
 
939
939
  @validate_arguments
940
940
  def list_transaction_templates(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt time at which to retrieve the Transaction Templates")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfTransactionTemplate, Awaitable[PagedResourceListOfTransactionTemplate]]: # noqa: E501
941
- """[EARLY ACCESS] ListTransactionTemplates: List Transaction Templates # noqa: E501
941
+ """ListTransactionTemplates: List Transaction Templates # noqa: E501
942
942
 
943
943
  Lists all Transaction Templates. # noqa: E501
944
944
  This method makes a synchronous HTTP request by default. To make an
@@ -977,7 +977,7 @@ class InstrumentEventTypesApi:
977
977
 
978
978
  @validate_arguments
979
979
  def list_transaction_templates_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The AsAt time at which to retrieve the Transaction Templates")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, 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, sort_by : Annotated[Optional[conlist(StrictStr)], Field(description="A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"")] = None, **kwargs) -> ApiResponse: # noqa: E501
980
- """[EARLY ACCESS] ListTransactionTemplates: List Transaction Templates # noqa: E501
980
+ """ListTransactionTemplates: List Transaction Templates # noqa: E501
981
981
 
982
982
  Lists all Transaction Templates. # noqa: E501
983
983
  This method makes a synchronous HTTP request by default. To make an
@@ -1126,7 +1126,7 @@ class InstrumentEventTypesApi:
1126
1126
 
1127
1127
  @validate_arguments
1128
1128
  def update_transaction_template(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies.")], transaction_template_request : Annotated[TransactionTemplateRequest, Field(..., description="A request defining the updated values for the transaction template.")], async_req: Optional[bool]=None, **kwargs) -> Union[TransactionTemplate, Awaitable[TransactionTemplate]]: # noqa: E501
1129
- """[EARLY ACCESS] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
1129
+ """UpdateTransactionTemplate: Update Transaction Template # noqa: E501
1130
1130
 
1131
1131
  Update a transaction template for a particular instrument event type in a scope. # noqa: E501
1132
1132
  This method makes a synchronous HTTP request by default. To make an
@@ -1163,7 +1163,7 @@ class InstrumentEventTypesApi:
1163
1163
 
1164
1164
  @validate_arguments
1165
1165
  def update_transaction_template_with_http_info(self, instrument_event_type : Annotated[StrictStr, Field(..., description="The type of instrument events that the template is applied to.")], instrument_type : Annotated[StrictStr, Field(..., description="The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template")], scope : Annotated[StrictStr, Field(..., description="The scope in which the template lies.")], transaction_template_request : Annotated[TransactionTemplateRequest, Field(..., description="A request defining the updated values for the transaction template.")], **kwargs) -> ApiResponse: # noqa: E501
1166
- """[EARLY ACCESS] UpdateTransactionTemplate: Update Transaction Template # noqa: E501
1166
+ """UpdateTransactionTemplate: Update Transaction Template # noqa: E501
1167
1167
 
1168
1168
  Update a transaction template for a particular instrument event type in a scope. # noqa: E501
1169
1169
  This method makes a synchronous HTTP request by default. To make an
lusid/api/instrument_events_api.py CHANGED
@@ -73,7 +73,7 @@ class InstrumentEventsApi:
73
73
 
74
74
  @validate_arguments
75
75
  def query_applicable_instrument_events(self, as_at : Annotated[Optional[datetime], Field(description="The as at time to use.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this")] = None, query_applicable_instrument_events_request : Annotated[Optional[QueryApplicableInstrumentEventsRequest], Field(description="The filter parameters used to retrieve applicable instrument events.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfApplicableInstrumentEvent, Awaitable[ResourceListOfApplicableInstrumentEvent]]: # noqa: E501
76
- """[EARLY ACCESS] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
76
+ """QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
77
77
 
78
78
  Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
79
79
  This method makes a synchronous HTTP request by default. To make an
@@ -110,7 +110,7 @@ class InstrumentEventsApi:
110
110
 
111
111
  @validate_arguments
112
112
  def query_applicable_instrument_events_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The as at time to use.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 100 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this")] = None, query_applicable_instrument_events_request : Annotated[Optional[QueryApplicableInstrumentEventsRequest], Field(description="The filter parameters used to retrieve applicable instrument events.")] = None, **kwargs) -> ApiResponse: # noqa: E501
113
- """[EARLY ACCESS] QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
113
+ """QueryApplicableInstrumentEvents: Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
114
114
 
115
115
  Returns a list of applicable instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
116
116
  This method makes a synchronous HTTP request by default. To make an
@@ -418,7 +418,7 @@ class InstrumentEventsApi:
418
418
 
419
419
  @validate_arguments
420
420
  def query_cash_flows(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_cash_flows_request : Annotated[Optional[QueryCashFlowsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfInstrumentCashFlow, Awaitable[ResourceListOfInstrumentCashFlow]]: # noqa: E501
421
- """[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
421
+ """QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
422
422
 
423
423
  Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
424
424
  This method makes a synchronous HTTP request by default. To make an
@@ -453,7 +453,7 @@ class InstrumentEventsApi:
453
453
 
454
454
  @validate_arguments
455
455
  def query_cash_flows_with_http_info(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_cash_flows_request : Annotated[Optional[QueryCashFlowsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, **kwargs) -> ApiResponse: # noqa: E501
456
- """[EXPERIMENTAL] QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
456
+ """QueryCashFlows: Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
457
457
 
458
458
  Returns a list of cashflows based on the holdings of the portfolios and date range specified in the query. # noqa: E501
459
459
  This method makes a synchronous HTTP request by default. To make an
@@ -593,7 +593,7 @@ class InstrumentEventsApi:
593
593
 
594
594
  @validate_arguments
595
595
  def query_instrument_events(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_instrument_events_request : Annotated[Optional[QueryInstrumentEventsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfInstrumentEventHolder, Awaitable[ResourceListOfInstrumentEventHolder]]: # noqa: E501
596
- """[EARLY ACCESS] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
596
+ """QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
597
597
 
598
598
  Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
599
599
  This method makes a synchronous HTTP request by default. To make an
@@ -628,7 +628,7 @@ class InstrumentEventsApi:
628
628
 
629
629
  @validate_arguments
630
630
  def query_instrument_events_with_http_info(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_instrument_events_request : Annotated[Optional[QueryInstrumentEventsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, **kwargs) -> ApiResponse: # noqa: E501
631
- """[EARLY ACCESS] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
631
+ """QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
632
632
 
633
633
  Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query. # noqa: E501
634
634
  This method makes a synchronous HTTP request by default. To make an
@@ -768,7 +768,7 @@ class InstrumentEventsApi:
768
768
 
769
769
  @validate_arguments
770
770
  def query_trade_tickets(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_trade_tickets_request : Annotated[Optional[QueryTradeTicketsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfPortfolioTradeTicket, Awaitable[ResourceListOfPortfolioTradeTicket]]: # noqa: E501
771
- """[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501
771
+ """QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501
772
772
 
773
773
  Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration. # noqa: E501
774
774
  This method makes a synchronous HTTP request by default. To make an
@@ -803,7 +803,7 @@ class InstrumentEventsApi:
803
803
 
804
804
  @validate_arguments
805
805
  def query_trade_tickets_with_http_info(self, limit : Annotated[Optional[StrictInt], Field(description="Optional. When paginating, limit the number of returned results to this many. If not specified, a default of 1000 is used.")] = None, page : Annotated[Optional[StrictStr], Field( description="Optional. The pagination token to use to continue listing items from a previous call. Page values are return from list calls, and must be supplied exactly as returned. Additionally, when specifying this value, queryBody, and limit must not be modified.")] = None, query_trade_tickets_request : Annotated[Optional[QueryTradeTicketsRequest], Field(description="The filter parameters used to retrieve instrument events.")] = None, **kwargs) -> ApiResponse: # noqa: E501
806
- """[EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501
806
+ """QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. # noqa: E501
807
807
 
808
808
  Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query. These trade tickets are derived from events that involve transition of instrument states, such as transitions on exercise or default of an instrument. The trade tickets are to allow the new position to be created given the existing portfolio configuration. # noqa: E501
809
809
  This method makes a synchronous HTTP request by default. To make an
lusid/api/instruments_api.py CHANGED
@@ -284,7 +284,7 @@ class InstrumentsApi:
284
284
 
285
285
  @validate_arguments
286
286
  def calculate_settlement_date(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[AddBusinessDaysToDateResponse, Awaitable[AddBusinessDaysToDateResponse]]: # noqa: E501
287
- """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
287
+ """CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
288
288
 
289
289
  Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. # noqa: E501
290
290
  This method makes a synchronous HTTP request by default. To make an
@@ -323,7 +323,7 @@ class InstrumentsApi:
323
323
 
324
324
  @validate_arguments
325
325
  def calculate_settlement_date_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], transaction_date : Annotated[Optional[StrictStr], Field( description="The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to returning the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
326
- """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
326
+ """CalculateSettlementDate: Get the settlement date for an instrument. # noqa: E501
327
327
 
328
328
  Get the settlement date for a given trade date and instrument. The calculated settlement date will be in UTC. If a cut label transaction date is provided, the settlement date will be calculated relative to the absolute UTC datetime. # noqa: E501
329
329
  This method makes a synchronous HTTP request by default. To make an
@@ -639,7 +639,7 @@ class InstrumentsApi:
639
639
 
640
640
  @validate_arguments
641
641
  def delete_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[DeleteInstrumentPropertiesResponse, Awaitable[DeleteInstrumentPropertiesResponse]]: # noqa: E501
642
- """[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties # noqa: E501
642
+ """DeleteInstrumentProperties: Delete instrument properties # noqa: E501
643
643
 
644
644
  Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
645
645
  This method makes a synchronous HTTP request by default. To make an
@@ -682,7 +682,7 @@ class InstrumentsApi:
682
682
 
683
683
  @validate_arguments
684
684
  def delete_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], request_body : Annotated[conlist(StrictStr), Field(..., description="A list of property keys from the 'Instruments' domain whose properties to delete.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Hierarchical Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Hierarchical Data Model to use")] = None, **kwargs) -> ApiResponse: # noqa: E501
685
- """[EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties # noqa: E501
685
+ """DeleteInstrumentProperties: Delete instrument properties # noqa: E501
686
686
 
687
687
  Delete one or more properties from a particular instrument. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion. # noqa: E501
688
688
  This method makes a synchronous HTTP request by default. To make an
@@ -1021,7 +1021,7 @@ class InstrumentsApi:
1021
1021
 
1022
1022
  @validate_arguments
1023
1023
  def get_all_possible_features(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], async_req: Optional[bool]=None, **kwargs) -> Union[Dict[str, List[str]], Awaitable[Dict[str, List[str]]]]: # noqa: E501
1024
- """[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
1024
+ """GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
1025
1025
 
1026
1026
  Provides all possible instrument features an instrument of a given type can provide. # noqa: E501
1027
1027
  This method makes a synchronous HTTP request by default. To make an
@@ -1052,7 +1052,7 @@ class InstrumentsApi:
1052
1052
 
1053
1053
  @validate_arguments
1054
1054
  def get_all_possible_features_with_http_info(self, instrument_type : Annotated[StrictStr, Field(..., description="A lusid instrument type e.g. Bond, FxOption.")], **kwargs) -> ApiResponse: # noqa: E501
1055
- """[EXPERIMENTAL] GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
1055
+ """GetAllPossibleFeatures: Provides list of all possible features for instrument type. # noqa: E501
1056
1056
 
1057
1057
  Provides all possible instrument features an instrument of a given type can provide. # noqa: E501
1058
1058
  This method makes a synchronous HTTP request by default. To make an
@@ -1173,7 +1173,7 @@ class InstrumentsApi:
1173
1173
 
1174
1174
  @validate_arguments
1175
1175
  def get_existing_instrument_capabilities(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. 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 instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
1176
- """[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1176
+ """GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1177
1177
 
1178
1178
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
1179
1179
  This method makes a synchronous HTTP request by default. To make an
@@ -1216,7 +1216,7 @@ class InstrumentsApi:
1216
1216
 
1217
1217
  @validate_arguments
1218
1218
  def get_existing_instrument_capabilities_with_http_info(self, identifier : Annotated[StrictStr, Field(..., description="A lusid instrument id identifying the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to retrieve the instrument. 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 instrument. Defaults to returning the latest version if not specified.")] = None, instrument_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, recipe_scope : Annotated[Optional[StrictStr], Field( description="The scope in which the recipe lies. When not supplied the scope is 'default'.")] = None, recipe_code : Annotated[Optional[StrictStr], Field( description="A unique identifier for an entity, used to obtain configuration recipe details. Default configuration recipe is used if not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1219
- """[EXPERIMENTAL] GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1219
+ """GetExistingInstrumentCapabilities: Retrieve capabilities of an existing instrument identified by LUID. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. Given an lusid instrument id provides instrument capabilities, outlining features, and, given the model, the capabilities also include supported addresses as well as economic dependencies. # noqa: E501
1220
1220
 
1221
1221
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
1222
1222
  This method makes a synchronous HTTP request by default. To make an
@@ -1919,7 +1919,7 @@ class InstrumentsApi:
1919
1919
 
1920
1920
  @validate_arguments
1921
1921
  def get_instrument_payment_diary(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentPaymentDiary, Awaitable[InstrumentPaymentDiary]]: # noqa: E501
1922
- """[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1922
+ """GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1923
1923
 
1924
1924
  Get the payment diary of a single instrument. # noqa: E501
1925
1925
  This method makes a synchronous HTTP request by default. To make an
@@ -1962,7 +1962,7 @@ class InstrumentsApi:
1962
1962
 
1963
1963
  @validate_arguments
1964
1964
  def get_instrument_payment_diary_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The identifier being supplied e.g. \"Figi\".")], identifier : Annotated[StrictStr, Field(..., description="The value of the identifier for the requested instrument.")], recipe_scope : Annotated[StrictStr, Field(..., description="The scope of the valuation recipe being used to generate the payment diary")], recipe_code : Annotated[StrictStr, Field(..., description="The code of the valuation recipe being used to generate the payment diary")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to return the latest version of each property if not specified.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
1965
- """[EXPERIMENTAL] GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1965
+ """GetInstrumentPaymentDiary: Get instrument payment diary # noqa: E501
1966
1966
 
1967
1967
  Get the payment diary of a single instrument. # noqa: E501
1968
1968
  This method makes a synchronous HTTP request by default. To make an
@@ -2528,7 +2528,7 @@ class InstrumentsApi:
2528
2528
 
2529
2529
  @validate_arguments
2530
2530
  def get_instrument_relationships(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. 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 relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfRelationship, Awaitable[ResourceListOfRelationship]]: # noqa: E501
2531
- """[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2531
+ """GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2532
2532
 
2533
2533
  Get relationships for a particular Instrument. # noqa: E501
2534
2534
  This method makes a synchronous HTTP request by default. To make an
@@ -2571,7 +2571,7 @@ class InstrumentsApi:
2571
2571
 
2572
2572
  @validate_arguments
2573
2573
  def get_instrument_relationships_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[StrictStr, Field(..., description="The identifier value.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to get relationships. 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 relationships. Defaults to return the latest LUSID AsAt time if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter relationships. Users should provide null or empty string for this field until further notice.")] = None, identifier_types : Annotated[Optional[conlist(StrictStr)], Field(description="Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The entity scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2574
- """[EARLY ACCESS] GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2574
+ """GetInstrumentRelationships: Get Instrument relationships # noqa: E501
2575
2575
 
2576
2576
  Get relationships for a particular Instrument. # noqa: E501
2577
2577
  This method makes a synchronous HTTP request by default. To make an
@@ -2944,7 +2944,7 @@ class InstrumentsApi:
2944
2944
 
2945
2945
  @validate_arguments
2946
2946
  def list_instrument_properties(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfProperty, Awaitable[ResourceListOfProperty]]: # noqa: E501
2947
- """[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2947
+ """ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2948
2948
 
2949
2949
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
2950
2950
  This method makes a synchronous HTTP request by default. To make an
@@ -2987,7 +2987,7 @@ class InstrumentsApi:
2987
2987
 
2988
2988
  @validate_arguments
2989
2989
  def list_instrument_properties_with_http_info(self, identifier_type : Annotated[StrictStr, Field(..., description="The unique identifier type to search, for example 'Figi'.")], identifier : Annotated[StrictStr, Field(..., description="An <i>identifierType</i> value to use to identify the instrument, for example 'BBG000BLNNV0'.")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label at which to list the instrument's properties. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the instrument's properties. Defaults to returning the latest version of each property if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing commands; this value is returned from the previous call.")] = None, limit : Annotated[Optional[conint(strict=True)], Field(description="When paginating, limit the results per page to this number.")] = None, scope : Annotated[Optional[StrictStr], Field( description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> ApiResponse: # noqa: E501
2990
- """[EARLY ACCESS] ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2990
+ """ListInstrumentProperties: Get instrument properties (with Pagination) # noqa: E501
2991
2991
 
2992
2992
  List all the properties of a particular instrument, as identified by a particular unique identifier. # noqa: E501
2993
2993
  This method makes a synchronous HTTP request by default. To make an
@@ -3385,7 +3385,7 @@ class InstrumentsApi:
3385
3385
 
3386
3386
  @validate_arguments
3387
3387
  def query_instrument_capabilities(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[InstrumentCapabilities, Awaitable[InstrumentCapabilities]]: # noqa: E501
3388
- """[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3388
+ """QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3389
3389
 
3390
3390
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
3391
3391
  This method makes a synchronous HTTP request by default. To make an
@@ -3418,7 +3418,7 @@ class InstrumentsApi:
3418
3418
 
3419
3419
  @validate_arguments
3420
3420
  def query_instrument_capabilities_with_http_info(self, lusid_instrument : Annotated[LusidInstrument, Field(..., description="The definition of the instrument.")], model : Annotated[Optional[StrictStr], Field( description="A pricing model for the instrument. Defaults to Unknown if not specified. If not specified the SupportedAddresses and EconomicDependencies are not provided.")] = None, **kwargs) -> ApiResponse: # noqa: E501
3421
- """[EXPERIMENTAL] QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3421
+ """QueryInstrumentCapabilities: Query capabilities of a particular instrument in advance of creating it. These include instrument features, and if model is provided it also includes supported address keys and economic dependencies. # noqa: E501
3422
3422
 
3423
3423
  Returns instrument capabilities containing useful information about the instrument and the model. This includes - features corresponding to the instrument e.g. Optionality:American, Other:InflationLinked - supported addresses (if model provided) e.g. Valuation/Pv, Valuation/DirtyPriceKey, Valuation/Accrued - economic dependencies (if model provided) e.g. Cash:USD, Fx:GBP.USD, Rates:GBP.GBPOIS # noqa: E501
3424
3424
  This method makes a synchronous HTTP request by default. To make an
lusid/api/order_instructions_api.py CHANGED
@@ -68,7 +68,7 @@ class OrderInstructionsApi:
68
68
 
69
69
  @validate_arguments
70
70
  def delete_order_instruction(self, scope : Annotated[StrictStr, Field(..., description="The orderInstruction scope.")], code : Annotated[StrictStr, Field(..., description="The orderInstruction's code. This, together with the scope uniquely identifies the orderInstruction to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[DeletedEntityResponse, Awaitable[DeletedEntityResponse]]: # noqa: E501
71
- """[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction # noqa: E501
71
+ """DeleteOrderInstruction: Delete orderInstruction # noqa: E501
72
72
 
73
73
  Delete an orderInstruction. Deletion will be valid from the orderInstruction's creation datetime. This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
74
74
  This method makes a synchronous HTTP request by default. To make an
@@ -101,7 +101,7 @@ class OrderInstructionsApi:
101
101
 
102
102
  @validate_arguments
103
103
  def delete_order_instruction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The orderInstruction scope.")], code : Annotated[StrictStr, Field(..., description="The orderInstruction's code. This, together with the scope uniquely identifies the orderInstruction to delete.")], **kwargs) -> ApiResponse: # noqa: E501
104
- """[EXPERIMENTAL] DeleteOrderInstruction: Delete orderInstruction # noqa: E501
104
+ """DeleteOrderInstruction: Delete orderInstruction # noqa: E501
105
105
 
106
106
  Delete an orderInstruction. Deletion will be valid from the orderInstruction's creation datetime. This means that the orderInstruction will no longer exist at any effective datetime from the asAt datetime of deletion. # noqa: E501
107
107
  This method makes a synchronous HTTP request by default. To make an
@@ -228,7 +228,7 @@ class OrderInstructionsApi:
228
228
 
229
229
  @validate_arguments
230
230
  def get_order_instruction(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the orderInstruction belongs.")], code : Annotated[StrictStr, Field(..., description="The orderInstruction's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"OrderInstruction\" domain to decorate onto the orderInstruction. These take the format {domain}/{scope}/{code} e.g. \"OrderInstruction/system/Name\".")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[OrderInstruction, Awaitable[OrderInstruction]]: # noqa: E501
231
- """[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction # noqa: E501
231
+ """GetOrderInstruction: Get OrderInstruction # noqa: E501
232
232
 
233
233
  Fetch a OrderInstruction that matches the specified identifier # noqa: E501
234
234
  This method makes a synchronous HTTP request by default. To make an
@@ -265,7 +265,7 @@ class OrderInstructionsApi:
265
265
 
266
266
  @validate_arguments
267
267
  def get_order_instruction_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to which the orderInstruction belongs.")], code : Annotated[StrictStr, Field(..., description="The orderInstruction's unique identifier.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"OrderInstruction\" domain to decorate onto the orderInstruction. These take the format {domain}/{scope}/{code} e.g. \"OrderInstruction/system/Name\".")] = None, **kwargs) -> ApiResponse: # noqa: E501
268
- """[EXPERIMENTAL] GetOrderInstruction: Get OrderInstruction # noqa: E501
268
+ """GetOrderInstruction: Get OrderInstruction # noqa: E501
269
269
 
270
270
  Fetch a OrderInstruction that matches the specified identifier # noqa: E501
271
271
  This method makes a synchronous HTTP request by default. To make an
@@ -408,7 +408,7 @@ class OrderInstructionsApi:
408
408
 
409
409
  @validate_arguments
410
410
  def list_order_instructions(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orderInstructions from a previous call to list orderInstructions. 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 or properties 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"OrderInstruction\" domain to decorate onto each orderInstruction. These take the format {domain}/{scope}/{code} e.g. \"OrderInstruction/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfOrderInstruction, Awaitable[PagedResourceListOfOrderInstruction]]: # noqa: E501
411
- """[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions # noqa: E501
411
+ """ListOrderInstructions: List OrderInstructions # noqa: E501
412
412
 
413
413
  Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). # noqa: E501
414
414
  This method makes a synchronous HTTP request by default. To make an
@@ -449,7 +449,7 @@ class OrderInstructionsApi:
449
449
 
450
450
  @validate_arguments
451
451
  def list_order_instructions_with_http_info(self, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the orderInstruction. Defaults to return the latest version of the orderInstruction if not specified.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing orderInstructions from a previous call to list orderInstructions. 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 or properties 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, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the \"OrderInstruction\" domain to decorate onto each orderInstruction. These take the format {domain}/{scope}/{code} e.g. \"OrderInstruction/system/Name\". All properties, except derived properties, are returned by default, without specifying here.")] = None, **kwargs) -> ApiResponse: # noqa: E501
452
- """[EXPERIMENTAL] ListOrderInstructions: List OrderInstructions # noqa: E501
452
+ """ListOrderInstructions: List OrderInstructions # noqa: E501
453
453
 
454
454
  Fetch the last pre-AsAt date version of each orderInstruction in scope (does not fetch the entire history). # noqa: E501
455
455
  This method makes a synchronous HTTP request by default. To make an
@@ -605,7 +605,7 @@ class OrderInstructionsApi:
605
605
 
606
606
  @validate_arguments
607
607
  def upsert_order_instructions(self, order_instruction_set_request : Annotated[Optional[OrderInstructionSetRequest], Field(description="The collection of orderInstruction requests.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[ResourceListOfOrderInstruction, Awaitable[ResourceListOfOrderInstruction]]: # noqa: E501
608
- """[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction # noqa: E501
608
+ """UpsertOrderInstructions: Upsert OrderInstruction # noqa: E501
609
609
 
610
610
  Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. # noqa: E501
611
611
  This method makes a synchronous HTTP request by default. To make an
@@ -636,7 +636,7 @@ class OrderInstructionsApi:
636
636
 
637
637
  @validate_arguments
638
638
  def upsert_order_instructions_with_http_info(self, order_instruction_set_request : Annotated[Optional[OrderInstructionSetRequest], Field(description="The collection of orderInstruction requests.")] = None, **kwargs) -> ApiResponse: # noqa: E501
639
- """[EXPERIMENTAL] UpsertOrderInstructions: Upsert OrderInstruction # noqa: E501
639
+ """UpsertOrderInstructions: Upsert OrderInstruction # noqa: E501
640
640
 
641
641
  Upsert; update existing orderInstructions with given ids, or create new orderInstructions otherwise. # noqa: E501
642
642
  This method makes a synchronous HTTP request by default. To make an