lusid-sdk 2.1.464__tar.gz → 2.1.472__tar.gz

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.464
+Version: 2.1.472
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -278,6 +278,7 @@ Class | Method | HTTP request | Description
 *InstrumentEventsApi* | [**query_instrument_events**](docs/InstrumentEventsApi.md#query_instrument_events) | **POST** /api/instrumentevents/$query | [EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
 *InstrumentEventsApi* | [**query_trade_tickets**](docs/InstrumentEventsApi.md#query_trade_tickets) | **POST** /api/instrumentevents/$queryTradeTickets | [EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.
 *InstrumentsApi* | [**batch_upsert_instrument_properties**](docs/InstrumentsApi.md#batch_upsert_instrument_properties) | **POST** /api/instruments/$batchupsertproperties | BatchUpsertInstrumentProperties: Batch upsert instruments properties
+*InstrumentsApi* | [**calculate_settlement_date**](docs/InstrumentsApi.md#calculate_settlement_date) | **GET** /api/instruments/{identifierType}/{identifier}/settlementdate | [EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument.
 *InstrumentsApi* | [**delete_instrument**](docs/InstrumentsApi.md#delete_instrument) | **DELETE** /api/instruments/{identifierType}/{identifier} | DeleteInstrument: Soft delete a single instrument
 *InstrumentsApi* | [**delete_instrument_properties**](docs/InstrumentsApi.md#delete_instrument_properties) | **POST** /api/instruments/{identifierType}/{identifier}/properties/$delete | [EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties
 *InstrumentsApi* | [**delete_instruments**](docs/InstrumentsApi.md#delete_instruments) | **POST** /api/instruments/$delete | DeleteInstruments: Soft or hard delete multiple instruments

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/README.md

@@ -252,6 +252,7 @@ Class | Method | HTTP request | Description
 *InstrumentEventsApi* | [**query_instrument_events**](docs/InstrumentEventsApi.md#query_instrument_events) | **POST** /api/instrumentevents/$query | [EXPERIMENTAL] QueryInstrumentEvents: Returns a list of instrument events based on the holdings of the portfolios and date range specified in the query.
 *InstrumentEventsApi* | [**query_trade_tickets**](docs/InstrumentEventsApi.md#query_trade_tickets) | **POST** /api/instrumentevents/$queryTradeTickets | [EXPERIMENTAL] QueryTradeTickets: Returns a list of trade tickets based on the holdings of the portfolios and date range specified in the query.
 *InstrumentsApi* | [**batch_upsert_instrument_properties**](docs/InstrumentsApi.md#batch_upsert_instrument_properties) | **POST** /api/instruments/$batchupsertproperties | BatchUpsertInstrumentProperties: Batch upsert instruments properties
+*InstrumentsApi* | [**calculate_settlement_date**](docs/InstrumentsApi.md#calculate_settlement_date) | **GET** /api/instruments/{identifierType}/{identifier}/settlementdate | [EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument.
 *InstrumentsApi* | [**delete_instrument**](docs/InstrumentsApi.md#delete_instrument) | **DELETE** /api/instruments/{identifierType}/{identifier} | DeleteInstrument: Soft delete a single instrument
 *InstrumentsApi* | [**delete_instrument_properties**](docs/InstrumentsApi.md#delete_instrument_properties) | **POST** /api/instruments/{identifierType}/{identifier}/properties/$delete | [EARLY ACCESS] DeleteInstrumentProperties: Delete instrument properties
 *InstrumentsApi* | [**delete_instruments**](docs/InstrumentsApi.md#delete_instruments) | **POST** /api/instruments/$delete | DeleteInstruments: Soft or hard delete multiple instruments

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/lusid/api/instruments_api.py

@@ -26,6 +26,7 @@ from pydantic.v1 import Field, StrictStr, conint, conlist, constr, validator
 
 from typing import Dict, List, Optional
 
+from lusid.models.add_business_days_to_date_response import AddBusinessDaysToDateResponse
 from lusid.models.batch_upsert_instrument_properties_response import BatchUpsertInstrumentPropertiesResponse
 from lusid.models.delete_instrument_properties_response import DeleteInstrumentPropertiesResponse
 from lusid.models.delete_instrument_response import DeleteInstrumentResponse
@@ -251,6 +252,192 @@ class InstrumentsApi:
             collection_formats=_collection_formats,
             _request_auth=_params.get('_request_auth'))
 
+    @overload
+    async def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), 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[constr(strict=True, max_length=64, min_length=1)], 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) -> AddBusinessDaysToDateResponse:  # noqa: E501
+        ...
+
+    @overload
+    def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), 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[constr(strict=True, max_length=64, min_length=1)], 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]=True, **kwargs) -> AddBusinessDaysToDateResponse:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def calculate_settlement_date(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), 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[constr(strict=True, max_length=64, min_length=1)], 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
+        """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument.  # noqa: E501
+
+        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
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.calculate_settlement_date(identifier_type, identifier, transaction_date, scope, as_at, async_req=True)
+        >>> result = thread.get()
+
+        :param identifier_type: An identifier type attached to the Instrument. (required)
+        :type identifier_type: str
+        :param identifier: The identifier value. (required)
+        :type identifier: str
+        :param transaction_date: The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.
+        :type transaction_date: str
+        :param scope: The scope in which the instrument lies. When not supplied the scope is 'default'.
+        :type scope: str
+        :param as_at: The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to              returning the latest version if not specified.
+        :type as_at: datetime
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: AddBusinessDaysToDateResponse
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the calculate_settlement_date_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        if async_req is not None:
+            kwargs['async_req'] = async_req
+        return self.calculate_settlement_date_with_http_info(identifier_type, identifier, transaction_date, scope, as_at, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def calculate_settlement_date_with_http_info(self, identifier_type : Annotated[constr(strict=True, max_length=64, min_length=1), Field(..., description="An identifier type attached to the Instrument.")], identifier : Annotated[constr(strict=True, max_length=64, min_length=1), 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[constr(strict=True, max_length=64, min_length=1)], 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
+        """[EARLY ACCESS] CalculateSettlementDate: Get the settlement date for an instrument.  # noqa: E501
+
+        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
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.calculate_settlement_date_with_http_info(identifier_type, identifier, transaction_date, scope, as_at, async_req=True)
+        >>> result = thread.get()
+
+        :param identifier_type: An identifier type attached to the Instrument. (required)
+        :type identifier_type: str
+        :param identifier: The identifier value. (required)
+        :type identifier: str
+        :param transaction_date: The transaction date to calculate the settlement date from. This can be a UTC datetime offset or a cut label.
+        :type transaction_date: str
+        :param scope: The scope in which the instrument lies. When not supplied the scope is 'default'.
+        :type scope: str
+        :param as_at: The asAt datetime at which to retrieve the related instrument and calendars for calculation. Defaults to              returning the latest version if not specified.
+        :type as_at: datetime
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
+        :param opts: Configuration options for this request
+        :type opts: ConfigurationOptions, optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(AddBusinessDaysToDateResponse, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'identifier_type',
+            'identifier',
+            'transaction_date',
+            'scope',
+            'as_at'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers',
+                'opts'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method calculate_settlement_date" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['identifier_type']:
+            _path_params['identifierType'] = _params['identifier_type']
+
+        if _params['identifier']:
+            _path_params['identifier'] = _params['identifier']
+
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('transaction_date') is not None:  # noqa: E501
+            _query_params.append(('transactionDate', _params['transaction_date']))
+
+        if _params.get('scope') is not None:  # noqa: E501
+            _query_params.append(('scope', _params['scope']))
+
+        if _params.get('as_at') is not None:  # noqa: E501
+            if isinstance(_params['as_at'], datetime):
+                _query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('asAt', _params['as_at']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '200': "AddBusinessDaysToDateResponse",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/instruments/{identifierType}/{identifier}/settlementdate', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            opts=_params.get('opts'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))
+
     @overload
     async def delete_instrument(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'.")], scope : Annotated[Optional[constr(strict=True, max_length=64, min_length=1)], Field(description="The scope in which the instrument lies. When not supplied the scope is 'default'.")] = None, **kwargs) -> DeleteInstrumentResponse:  # noqa: E501
         ...

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/lusid/configuration.py

@@ -445,7 +445,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.6893\n"\
+               "Version of the API: 0.11.6901\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/lusid/models/component_transaction.py

@@ -19,7 +19,7 @@ import json
 
 
 from typing import Any, Dict, List, Optional
-from pydantic.v1 import BaseModel, Field, conlist, constr
+from pydantic.v1 import BaseModel, Field, StrictBool, conlist, constr
 from lusid.models.transaction_field_map import TransactionFieldMap
 from lusid.models.transaction_property_map import TransactionPropertyMap
 
@@ -31,7 +31,8 @@ class ComponentTransaction(BaseModel):
     condition: Optional[constr(strict=True, max_length=1024, min_length=0)] = None
     transaction_field_map: TransactionFieldMap = Field(..., alias="transactionFieldMap")
     transaction_property_map: conlist(TransactionPropertyMap) = Field(..., alias="transactionPropertyMap")
-    __properties = ["displayName", "condition", "transactionFieldMap", "transactionPropertyMap"]
+    preserve_tax_lot_structure: Optional[StrictBool] = Field(None, alias="preserveTaxLotStructure", description="Controls if tax lot structure should be preserved when cost base is transferred to a new holding. For example in Spin Off instrument events.")
+    __properties = ["displayName", "condition", "transactionFieldMap", "transactionPropertyMap", "preserveTaxLotStructure"]
 
     class Config:
         """Pydantic configuration"""
@@ -72,6 +73,11 @@ class ComponentTransaction(BaseModel):
         if self.condition is None and "condition" in self.__fields_set__:
             _dict['condition'] = None
 
+        # set to None if preserve_tax_lot_structure (nullable) is None
+        # and __fields_set__ contains the field
+        if self.preserve_tax_lot_structure is None and "preserve_tax_lot_structure" in self.__fields_set__:
+            _dict['preserveTaxLotStructure'] = None
+
         return _dict
 
     @classmethod
@@ -87,6 +93,7 @@ class ComponentTransaction(BaseModel):
             "display_name": obj.get("displayName"),
             "condition": obj.get("condition"),
             "transaction_field_map": TransactionFieldMap.from_dict(obj.get("transactionFieldMap")) if obj.get("transactionFieldMap") is not None else None,
-            "transaction_property_map": [TransactionPropertyMap.from_dict(_item) for _item in obj.get("transactionPropertyMap")] if obj.get("transactionPropertyMap") is not None else None
+            "transaction_property_map": [TransactionPropertyMap.from_dict(_item) for _item in obj.get("transactionPropertyMap")] if obj.get("transactionPropertyMap") is not None else None,
+            "preserve_tax_lot_structure": obj.get("preserveTaxLotStructure")
         })
         return _obj

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/lusid/models/transaction_price.py

@@ -26,7 +26,7 @@ class TransactionPrice(BaseModel):
     TransactionPrice
     """
     price: Optional[Union[StrictFloat, StrictInt]] = None
-    type: Optional[StrictStr] = Field(None, description="The available values are: Price, Yield, Spread, CashFlowPerUnit")
+    type: Optional[StrictStr] = Field(None, description="The available values are: Price, Yield, Spread, CashFlowPerUnit, CleanPrice, DirtyPrice")
     __properties = ["price", "type"]
 
     @validator('type')
@@ -35,8 +35,8 @@ class TransactionPrice(BaseModel):
         if value is None:
             return value
 
-        if value not in ('Price', 'Yield', 'Spread', 'CashFlowPerUnit'):
-            raise ValueError("must be one of enum values ('Price', 'Yield', 'Spread', 'CashFlowPerUnit')")
+        if value not in ('Price', 'Yield', 'Spread', 'CashFlowPerUnit', 'CleanPrice', 'DirtyPrice'):
+            raise ValueError("must be one of enum values ('Price', 'Yield', 'Spread', 'CashFlowPerUnit', 'CleanPrice', 'DirtyPrice')")
         return value
 
     class Config:

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/lusid/models/transaction_price_type.py

@@ -33,6 +33,8 @@ class TransactionPriceType(str, Enum):
     YIELD = 'Yield'
     SPREAD = 'Spread'
     CASHFLOWPERUNIT = 'CashFlowPerUnit'
+    CLEANPRICE = 'CleanPrice'
+    DIRTYPRICE = 'DirtyPrice'
 
     @classmethod
     def from_json(cls, json_str: str) -> TransactionPriceType:

{lusid_sdk-2.1.464 → lusid_sdk-2.1.472}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lusid-sdk"
-version = "2.1.464"
+version = "2.1.472"
 description = "LUSID API"
 authors = ["FINBOURNE Technology <info@finbourne.com>"]
 license = "MIT"