lusid-sdk 2.1.921__py3-none-any.whl → 2.1.922__py3-none-any.whl

lusid/__init__.py

@@ -1229,7 +1229,10 @@ from lusid.models.transaction_request import TransactionRequest
 from lusid.models.transaction_roles import TransactionRoles
 from lusid.models.transaction_set_configuration_data import TransactionSetConfigurationData
 from lusid.models.transaction_set_configuration_data_request import TransactionSetConfigurationDataRequest
+from lusid.models.transaction_settlement_bucket import TransactionSettlementBucket
 from lusid.models.transaction_settlement_instruction import TransactionSettlementInstruction
+from lusid.models.transaction_settlement_movement import TransactionSettlementMovement
+from lusid.models.transaction_settlement_status import TransactionSettlementStatus
 from lusid.models.transaction_status import TransactionStatus
 from lusid.models.transaction_template import TransactionTemplate
 from lusid.models.transaction_template_request import TransactionTemplateRequest
@@ -2604,7 +2607,10 @@ __all__ = [
     "TransactionRoles",
     "TransactionSetConfigurationData",
     "TransactionSetConfigurationDataRequest",
+    "TransactionSettlementBucket",
     "TransactionSettlementInstruction",
+    "TransactionSettlementMovement",
+    "TransactionSettlementStatus",
     "TransactionStatus",
     "TransactionTemplate",
     "TransactionTemplateRequest",

lusid/api/transaction_portfolios_api.py

@@ -64,6 +64,7 @@ from lusid.models.resource_list_of_transaction_settlement_instruction import Res
 from lusid.models.settlement_instruction_request import SettlementInstructionRequest
 from lusid.models.transaction_query_parameters import TransactionQueryParameters
 from lusid.models.transaction_request import TransactionRequest
+from lusid.models.transaction_settlement_status import TransactionSettlementStatus
 from lusid.models.upsert_portfolio_transactions_response import UpsertPortfolioTransactionsResponse
 from lusid.models.upsert_transaction_properties_response import UpsertTransactionPropertiesResponse
 from lusid.models.versioned_resource_list_of_a2_b_data_record import VersionedResourceListOfA2BDataRecord
@@ -5664,6 +5665,193 @@ class TransactionPortfoliosApi:
             _request_auth=_params.get('_request_auth'))
 
 
+    @overload
+    async def get_transaction_settlement_status(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The id of the transaction")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status if not specified.")] = None, **kwargs) -> TransactionSettlementStatus:  # noqa: E501
+        ...
+
+    @overload
+    def get_transaction_settlement_status(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The id of the transaction")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> TransactionSettlementStatus:  # noqa: E501
+        ...
+
+    @validate_arguments
+    def get_transaction_settlement_status(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The id of the transaction")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[TransactionSettlementStatus, Awaitable[TransactionSettlementStatus]]:  # noqa: E501
+        """[EARLY ACCESS] GetTransactionSettlementStatus: Gets the Transaction Settlement Status for the requested transaction.  # noqa: E501
+
+        Gets the Transaction Settlement Status for the requested transaction.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_transaction_settlement_status(scope, code, transaction_id, effective_at, as_at, async_req=True)
+        >>> result = thread.get()
+
+        :param scope: The scope of the transaction portfolio. (required)
+        :type scope: str
+        :param code: The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio. (required)
+        :type code: str
+        :param transaction_id: The id of the transaction (required)
+        :type transaction_id: str
+        :param effective_at: The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.
+        :type effective_at: str
+        :param as_at: The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status 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: TransactionSettlementStatus
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the get_transaction_settlement_status_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.get_transaction_settlement_status_with_http_info(scope, code, transaction_id, effective_at, as_at, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def get_transaction_settlement_status_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio.")], transaction_id : Annotated[StrictStr, Field(..., description="The id of the transaction")], effective_at : Annotated[Optional[StrictStr], Field( description="The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status if not specified.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """[EARLY ACCESS] GetTransactionSettlementStatus: Gets the Transaction Settlement Status for the requested transaction.  # noqa: E501
+
+        Gets the Transaction Settlement Status for the requested transaction.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_transaction_settlement_status_with_http_info(scope, code, transaction_id, effective_at, as_at, async_req=True)
+        >>> result = thread.get()
+
+        :param scope: The scope of the transaction portfolio. (required)
+        :type scope: str
+        :param code: The code of the transaction portfolio. Together with the scope this uniquely identifies              the transaction portfolio. (required)
+        :type code: str
+        :param transaction_id: The id of the transaction (required)
+        :type transaction_id: str
+        :param effective_at: The effective datetime or cut label for which to get the transaction               settlement status. Defaults to the current LUSID system datetime if not specified.
+        :type effective_at: str
+        :param as_at: The asAt datetime at which to get the transaction settlement status.               Defaults to return the latest status 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(TransactionSettlementStatus, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'scope',
+            'code',
+            'transaction_id',
+            'effective_at',
+            '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 get_transaction_settlement_status" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['scope']:
+            _path_params['scope'] = _params['scope']
+
+        if _params['code']:
+            _path_params['code'] = _params['code']
+
+        if _params['transaction_id']:
+            _path_params['transactionId'] = _params['transaction_id']
+
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('effective_at') is not None:  # noqa: E501
+            _query_params.append(('effectiveAt', _params['effective_at']))
+
+        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': "TransactionSettlementStatus",
+            '400': "LusidValidationProblemDetails",
+        }
+
+        return self.api_client.call_api(
+            '/api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/settlementstatus', '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 get_transactions(self, scope : Annotated[StrictStr, Field(..., description="The scope of the transaction portfolio.")], code : Annotated[StrictStr, Field(..., description="The code of the transaction portfolio. Together with the scope this uniquely identifies               the transaction portfolio.")], from_transaction_date : Annotated[Optional[StrictStr], Field( description="The lower bound effective datetime or cut label (inclusive) from which to retrieve transactions.               There is no lower bound if this is not specified.")] = None, to_transaction_date : Annotated[Optional[StrictStr], Field( description="The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions.               There is no upper bound if this is not specified.")] = None, as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve transactions. Defaults to returning the latest version               of each transaction if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression with which to filter the result set.               For example, to return only transactions with a transaction type of 'Buy', specify \"type eq 'Buy'\"               For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914.")] = None, property_keys : Annotated[Optional[conlist(StrictStr)], Field(description="A list of property keys from the 'Instrument', 'Transaction', \"LegalEntity\" or \"CustodianAccount\" domain to decorate onto               transactions. These must have the format {domain}/{scope}/{code}, for example 'Instrument/system/Name' or               'Transaction/strategy/quantsignal'.")] = None, page : Annotated[Optional[StrictStr], Field( description="The pagination token to use to continue listing transactions from a previous call to GetTransactions.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, limit the number of returned results to this many. The current behaviour is               to return all transactions if possible, but this will change to defaulting to 1000 if not specified in the future. It is recommended               to populate this field to enable pagination.")] = None, show_cancelled_transactions : Annotated[Optional[StrictBool], Field(description="Option to specify whether or not to include cancelled transactions,               including previous versions of transactions which have since been amended.               Defaults to False if not specified.")] = 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, data_model_scope : Annotated[Optional[StrictStr], Field( description="The optional scope of a Custom Data Model to use")] = None, data_model_code : Annotated[Optional[StrictStr], Field( description="The optional code of a Custom Data Model to use")] = None, **kwargs) -> VersionedResourceListOfTransaction:  # noqa: E501
         ...

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.8196\n"\
+               "Version of the API: 0.11.8197\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/__init__.py

@@ -1138,7 +1138,10 @@ from lusid.models.transaction_request import TransactionRequest
 from lusid.models.transaction_roles import TransactionRoles
 from lusid.models.transaction_set_configuration_data import TransactionSetConfigurationData
 from lusid.models.transaction_set_configuration_data_request import TransactionSetConfigurationDataRequest
+from lusid.models.transaction_settlement_bucket import TransactionSettlementBucket
 from lusid.models.transaction_settlement_instruction import TransactionSettlementInstruction
+from lusid.models.transaction_settlement_movement import TransactionSettlementMovement
+from lusid.models.transaction_settlement_status import TransactionSettlementStatus
 from lusid.models.transaction_status import TransactionStatus
 from lusid.models.transaction_template import TransactionTemplate
 from lusid.models.transaction_template_request import TransactionTemplateRequest
@@ -2423,7 +2426,10 @@ __all__ = [
     "TransactionRoles",
     "TransactionSetConfigurationData",
     "TransactionSetConfigurationDataRequest",
+    "TransactionSettlementBucket",
     "TransactionSettlementInstruction",
+    "TransactionSettlementMovement",
+    "TransactionSettlementStatus",
     "TransactionStatus",
     "TransactionTemplate",
     "TransactionTemplateRequest",

lusid/models/transaction_settlement_bucket.py

@@ -0,0 +1,135 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictFloat, StrictInt, StrictStr, conlist, constr 
+from lusid.models.transaction_settlement_instruction import TransactionSettlementInstruction
+from lusid.models.transaction_settlement_movement import TransactionSettlementMovement
+
+class TransactionSettlementBucket(BaseModel):
+    """
+    TransactionSettlementBucket
+    """
+    settlement_category:  StrictStr = Field(...,alias="settlementCategory", description="A category representing the set of movement types that this instruction applies to.") 
+    lusid_instrument_id:  StrictStr = Field(...,alias="lusidInstrumentId", description="The LusidInstrumentId of the instrument being settled.") 
+    instrument_scope:  StrictStr = Field(...,alias="instrumentScope", description="The Scope of the instrument being settled.") 
+    contractual_settlement_date: Optional[datetime] = Field(None, alias="contractualSettlementDate", description="The contractual settlement date. Used to match the instruction to the correct settlement bucket.")
+    contracted_units: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="contractedUnits", description="The contracted units.")
+    settled_units: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="settledUnits", description="The settled units.")
+    unsettled_units: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="unsettledUnits", description="The unsettled units.")
+    overdue_units: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="overdueUnits", description="The overdue units.")
+    configured_settlement:  Optional[StrictStr] = Field(None,alias="configuredSettlement", description="The method of settlement for the settlement bucket, as defined in the portfolio's SettlementConfiguration") 
+    status:  StrictStr = Field(...,alias="status", description="The Status of the settlement bucket - 'Settled', 'Part Settled' or 'Unsettled'.") 
+    settlement_instructions: Optional[conlist(TransactionSettlementInstruction)] = Field(None, alias="settlementInstructions", description="The settlement instructions received for this settlement bucket.")
+    movements: Optional[conlist(TransactionSettlementMovement)] = Field(None, description="The movements for the settlement bucket.")
+    __properties = ["settlementCategory", "lusidInstrumentId", "instrumentScope", "contractualSettlementDate", "contractedUnits", "settledUnits", "unsettledUnits", "overdueUnits", "configuredSettlement", "status", "settlementInstructions", "movements"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> TransactionSettlementBucket:
+        """Create an instance of TransactionSettlementBucket from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in settlement_instructions (list)
+        _items = []
+        if self.settlement_instructions:
+            for _item in self.settlement_instructions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['settlementInstructions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in movements (list)
+        _items = []
+        if self.movements:
+            for _item in self.movements:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['movements'] = _items
+        # set to None if contractual_settlement_date (nullable) is None
+        # and __fields_set__ contains the field
+        if self.contractual_settlement_date is None and "contractual_settlement_date" in self.__fields_set__:
+            _dict['contractualSettlementDate'] = None
+
+        # set to None if configured_settlement (nullable) is None
+        # and __fields_set__ contains the field
+        if self.configured_settlement is None and "configured_settlement" in self.__fields_set__:
+            _dict['configuredSettlement'] = None
+
+        # set to None if settlement_instructions (nullable) is None
+        # and __fields_set__ contains the field
+        if self.settlement_instructions is None and "settlement_instructions" in self.__fields_set__:
+            _dict['settlementInstructions'] = None
+
+        # set to None if movements (nullable) is None
+        # and __fields_set__ contains the field
+        if self.movements is None and "movements" in self.__fields_set__:
+            _dict['movements'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionSettlementBucket:
+        """Create an instance of TransactionSettlementBucket from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionSettlementBucket.parse_obj(obj)
+
+        _obj = TransactionSettlementBucket.parse_obj({
+            "settlement_category": obj.get("settlementCategory"),
+            "lusid_instrument_id": obj.get("lusidInstrumentId"),
+            "instrument_scope": obj.get("instrumentScope"),
+            "contractual_settlement_date": obj.get("contractualSettlementDate"),
+            "contracted_units": obj.get("contractedUnits"),
+            "settled_units": obj.get("settledUnits"),
+            "unsettled_units": obj.get("unsettledUnits"),
+            "overdue_units": obj.get("overdueUnits"),
+            "configured_settlement": obj.get("configuredSettlement"),
+            "status": obj.get("status"),
+            "settlement_instructions": [TransactionSettlementInstruction.from_dict(_item) for _item in obj.get("settlementInstructions")] if obj.get("settlementInstructions") is not None else None,
+            "movements": [TransactionSettlementMovement.from_dict(_item) for _item in obj.get("movements")] if obj.get("movements") is not None else None
+        })
+        return _obj

lusid/models/transaction_settlement_instruction.py

@@ -38,7 +38,8 @@ class TransactionSettlementInstruction(BaseModel):
     sub_holding_key_overrides: Optional[Dict[str, PerpetualProperty]] = Field(None, alias="subHoldingKeyOverrides", description="Allows one or more sub-holding keys to be overridden for any movement being settled by an instruction. Providing a key and value will set the sub-holding key to the specified value; Providing a key only will nullify the sub-holding key. Not referenced sub-holding keys will not be impacted. ")
     custodian_account_override: Optional[ResourceId] = Field(None, alias="custodianAccountOverride")
     instrument_identifiers: Dict[str, StrictStr] = Field(..., alias="instrumentIdentifiers", description="A set of instrument identifiers that can resolve the settlement instruction to a unique instrument.")
-    __properties = ["settlementInstructionId", "instructionType", "actualSettlementDate", "units", "transactionId", "settlementCategory", "lusidInstrumentId", "contractualSettlementDate", "subHoldingKeyOverrides", "custodianAccountOverride", "instrumentIdentifiers"]
+    status:  Optional[StrictStr] = Field(None,alias="status", description="The status of the settlement instruction - 'Invalid', 'Rejected' 'Applied' or 'Orphan'.") 
+    __properties = ["settlementInstructionId", "instructionType", "actualSettlementDate", "units", "transactionId", "settlementCategory", "lusidInstrumentId", "contractualSettlementDate", "subHoldingKeyOverrides", "custodianAccountOverride", "instrumentIdentifiers", "status"]
 
     class Config:
         """Pydantic configuration"""
@@ -92,6 +93,11 @@ class TransactionSettlementInstruction(BaseModel):
         if self.sub_holding_key_overrides is None and "sub_holding_key_overrides" in self.__fields_set__:
             _dict['subHoldingKeyOverrides'] = None
 
+        # set to None if status (nullable) is None
+        # and __fields_set__ contains the field
+        if self.status is None and "status" in self.__fields_set__:
+            _dict['status'] = None
+
         return _dict
 
     @classmethod
@@ -119,6 +125,7 @@ class TransactionSettlementInstruction(BaseModel):
             if obj.get("subHoldingKeyOverrides") is not None
             else None,
             "custodian_account_override": ResourceId.from_dict(obj.get("custodianAccountOverride")) if obj.get("custodianAccountOverride") is not None else None,
-            "instrument_identifiers": obj.get("instrumentIdentifiers")
+            "instrument_identifiers": obj.get("instrumentIdentifiers"),
+            "status": obj.get("status")
         })
         return _obj

lusid/models/transaction_settlement_movement.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, Optional, Union
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, StrictFloat, StrictInt, StrictStr 
+
+class TransactionSettlementMovement(BaseModel):
+    """
+    TransactionSettlementMovement
+    """
+    name:  Optional[StrictStr] = Field(None,alias="name", description="The movement name (optional)") 
+    type:  Optional[StrictStr] = Field(None,alias="type", description="Movement types determine the impact of the movement on the holdings. The available values are: Settlement, Traded, StockMovement, FutureCash,  Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, Carry, CarryAsPnl, VariationMargin, Capital, Fee, Deferred, CashDeferred.") 
+    units: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The number of units for the movement.")
+    direction: Optional[StrictInt] = Field(None, description=" A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease")
+    settlement_mode:  Optional[StrictStr] = Field(None,alias="settlementMode", description="The mode of settlement for the movement which can either be Internal or External. An Internal movement will settle automatically on the contractual settlement date using TransactionConfiguration. An External movement will be determined by portfolio configuration and settlement instruction.") 
+    __properties = ["name", "type", "units", "direction", "settlementMode"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> TransactionSettlementMovement:
+        """Create an instance of TransactionSettlementMovement from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # set to None if name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.name is None and "name" in self.__fields_set__:
+            _dict['name'] = None
+
+        # set to None if type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.type is None and "type" in self.__fields_set__:
+            _dict['type'] = None
+
+        # set to None if settlement_mode (nullable) is None
+        # and __fields_set__ contains the field
+        if self.settlement_mode is None and "settlement_mode" in self.__fields_set__:
+            _dict['settlementMode'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionSettlementMovement:
+        """Create an instance of TransactionSettlementMovement from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionSettlementMovement.parse_obj(obj)
+
+        _obj = TransactionSettlementMovement.parse_obj({
+            "name": obj.get("name"),
+            "type": obj.get("type"),
+            "units": obj.get("units"),
+            "direction": obj.get("direction"),
+            "settlement_mode": obj.get("settlementMode")
+        })
+        return _obj

lusid/models/transaction_settlement_status.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, Dict, List, Optional
+from pydantic.v1 import StrictStr, Field, BaseModel, Field, conlist, constr 
+from lusid.models.link import Link
+from lusid.models.transaction_settlement_bucket import TransactionSettlementBucket
+from lusid.models.transaction_settlement_instruction import TransactionSettlementInstruction
+
+class TransactionSettlementStatus(BaseModel):
+    """
+    TransactionSettlementStatus
+    """
+    transaction_id:  StrictStr = Field(...,alias="transactionId", description="The unique identifier for the transaction.") 
+    settlement_buckets: Optional[conlist(TransactionSettlementBucket)] = Field(None, alias="settlementBuckets", description="The transaction's external movements (ie: with SettlementMode=External) are grouped into buckets with each bucket uniquely defined by the combination of SettlementCategory, LusidInstrumentId, InstrumentScope and ContractualSettlementDate.")
+    invalid_instructions: Optional[conlist(TransactionSettlementInstruction)] = Field(None, alias="invalidInstructions", description="Invalid settlement instructions where the referenced transaction exists but the settlement bucket implied by the settlement instruction does not exist.")
+    links: Optional[conlist(Link)] = None
+    __properties = ["transactionId", "settlementBuckets", "invalidInstructions", "links"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def __str__(self):
+        """For `print` and `pprint`"""
+        return pprint.pformat(self.dict(by_alias=False))
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> TransactionSettlementStatus:
+        """Create an instance of TransactionSettlementStatus from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in settlement_buckets (list)
+        _items = []
+        if self.settlement_buckets:
+            for _item in self.settlement_buckets:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['settlementBuckets'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in invalid_instructions (list)
+        _items = []
+        if self.invalid_instructions:
+            for _item in self.invalid_instructions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['invalidInstructions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in links (list)
+        _items = []
+        if self.links:
+            for _item in self.links:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['links'] = _items
+        # set to None if settlement_buckets (nullable) is None
+        # and __fields_set__ contains the field
+        if self.settlement_buckets is None and "settlement_buckets" in self.__fields_set__:
+            _dict['settlementBuckets'] = None
+
+        # set to None if invalid_instructions (nullable) is None
+        # and __fields_set__ contains the field
+        if self.invalid_instructions is None and "invalid_instructions" in self.__fields_set__:
+            _dict['invalidInstructions'] = None
+
+        # set to None if links (nullable) is None
+        # and __fields_set__ contains the field
+        if self.links is None and "links" in self.__fields_set__:
+            _dict['links'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionSettlementStatus:
+        """Create an instance of TransactionSettlementStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionSettlementStatus.parse_obj(obj)
+
+        _obj = TransactionSettlementStatus.parse_obj({
+            "transaction_id": obj.get("transactionId"),
+            "settlement_buckets": [TransactionSettlementBucket.from_dict(_item) for _item in obj.get("settlementBuckets")] if obj.get("settlementBuckets") is not None else None,
+            "invalid_instructions": [TransactionSettlementInstruction.from_dict(_item) for _item in obj.get("invalidInstructions")] if obj.get("invalidInstructions") is not None else None,
+            "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
+        })
+        return _obj

{lusid_sdk-2.1.921.dist-info → lusid_sdk-2.1.922.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.921
+Version: 2.1.922
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -654,6 +654,7 @@ Class | Method | HTTP request | Description
 *TransactionPortfoliosApi* | [**get_portfolio_cash_ladder**](docs/TransactionPortfoliosApi.md#get_portfolio_cash_ladder) | **GET** /api/transactionportfolios/{scope}/{code}/cashladder | GetPortfolioCashLadder: Get portfolio cash ladder
 *TransactionPortfoliosApi* | [**get_portfolio_cash_statement**](docs/TransactionPortfoliosApi.md#get_portfolio_cash_statement) | **GET** /api/transactionportfolios/{scope}/{code}/cashstatement | GetPortfolioCashStatement: Get portfolio cash statement
 *TransactionPortfoliosApi* | [**get_transaction_history**](docs/TransactionPortfoliosApi.md#get_transaction_history) | **GET** /api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/history | GetTransactionHistory: Get the history of a transaction
+*TransactionPortfoliosApi* | [**get_transaction_settlement_status**](docs/TransactionPortfoliosApi.md#get_transaction_settlement_status) | **GET** /api/transactionportfolios/{scope}/{code}/transactions/{transactionId}/settlementstatus | [EARLY ACCESS] GetTransactionSettlementStatus: Gets the Transaction Settlement Status for the requested transaction.
 *TransactionPortfoliosApi* | [**get_transactions**](docs/TransactionPortfoliosApi.md#get_transactions) | **GET** /api/transactionportfolios/{scope}/{code}/transactions | GetTransactions: Get transactions
 *TransactionPortfoliosApi* | [**get_upsertable_portfolio_cash_flows**](docs/TransactionPortfoliosApi.md#get_upsertable_portfolio_cash_flows) | **GET** /api/transactionportfolios/{scope}/{code}/upsertablecashflows | GetUpsertablePortfolioCashFlows: Get upsertable portfolio cash flows.
 *TransactionPortfoliosApi* | [**list_custodian_accounts**](docs/TransactionPortfoliosApi.md#list_custodian_accounts) | **GET** /api/transactionportfolios/{scope}/{code}/custodianaccounts | ListCustodianAccounts: List Custodian Accounts
@@ -1812,7 +1813,10 @@ Class | Method | HTTP request | Description
  - [TransactionRoles](docs/TransactionRoles.md)
  - [TransactionSetConfigurationData](docs/TransactionSetConfigurationData.md)
  - [TransactionSetConfigurationDataRequest](docs/TransactionSetConfigurationDataRequest.md)
+ - [TransactionSettlementBucket](docs/TransactionSettlementBucket.md)
  - [TransactionSettlementInstruction](docs/TransactionSettlementInstruction.md)
+ - [TransactionSettlementMovement](docs/TransactionSettlementMovement.md)
+ - [TransactionSettlementStatus](docs/TransactionSettlementStatus.md)
  - [TransactionStatus](docs/TransactionStatus.md)
  - [TransactionTemplate](docs/TransactionTemplate.md)
  - [TransactionTemplateRequest](docs/TransactionTemplateRequest.md)

{lusid_sdk-2.1.921.dist-info → lusid_sdk-2.1.922.dist-info}/RECORD

@@ -1,4 +1,4 @@
-lusid/__init__.py,sha256=n54AObd6qFlD0RELAbs9WWYcqeozjOtYDVOSv5PFmlo,145447
+lusid/__init__.py,sha256=wqp9xJUB-EHXH8emzSuIH5KX3ZBkTzRNS1Z72mp51_0,145807
 lusid/api/__init__.py,sha256=yCGwgeQBZ1RZovOUo7Jq24Txz4o6naRgnWAzQVGdHAk,6784
 lusid/api/abor_api.py,sha256=N7Wsh0395mXOvpJI8z0Nrx5OY4nCP5FN9RkbtdHaZbM,165987
 lusid/api/abor_configuration_api.py,sha256=xQ9HcXm02eDFhCdWUHjqFRWl1oQMxm2LNObJ9kcLauU,84216
@@ -74,13 +74,13 @@ lusid/api/tax_rule_sets_api.py,sha256=ia8zjTdwlgLGC8KDWFBT21agOrfWgn1zC_ik75mNDJ
 lusid/api/timelines_api.py,sha256=uxSMdLi9dI6y8LSaezsLXEVedy9I7A-k22RAKY0Rw4k,109878
 lusid/api/transaction_configuration_api.py,sha256=OHs853-U1RWs2oApEO3raiMxixxiMQMcXu566qsm5v4,103968
 lusid/api/transaction_fees_api.py,sha256=r8Gl44-WYZebyJ_Uw2stLsf3-hPi1bK6Ij64Kx0L6A8,62698
-lusid/api/transaction_portfolios_api.py,sha256=5LRYXZIe6eKjzINklTERxThuWu3X3rbMaK3q_dum-rM,656364
+lusid/api/transaction_portfolios_api.py,sha256=nhd5cm-eUcNCnZGyznGvFnbBLRoT6mN627U-ZC1E5nA,668854
 lusid/api/transfer_agency_api.py,sha256=m-o3srFi7ZcUcWlO_lpOJiYZJvDSt2JLy7QPcXQoPh4,9545
 lusid/api/translation_api.py,sha256=xpRuTfwQvYBlWe6r_L2EI_uVpXqHFnEOim-i-kVQ85E,20227
 lusid/api/workspace_api.py,sha256=0pCNi3ZCRbIo0NXKa85XE7vtq0WV5YOKcQKvFlcLUaY,120708
 lusid/api_client.py,sha256=ewMTmf9SRurY8pYnUx9jy24RdldPCOa4US38pnrVxjA,31140
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=PmwtwZivM7VH6Bmy-ptkP27bP9GeIH5W_UTesm0ML3c,17980
+lusid/configuration.py,sha256=eC2OZZIHepewROEJ92SrnVm8OsBxnWZFI5EnfJSFdGU,17980
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=dzDHEzpn-9smd2-_UMWQzeyX6Ha4jGf6fnqx7qxKxNI,630
 lusid/extensions/api_client.py,sha256=GzygWg_h603QK1QS2HvAijuE2R1TnvoF6-Yg0CeM3ug,30943
@@ -95,7 +95,7 @@ lusid/extensions/rest.py,sha256=dp-bD_LMR2zAL1tmC3-urhWKLomXx7r5iGN1VteMBVQ,1601
 lusid/extensions/retry.py,sha256=EhW9OKJmGHipxN3H7eROH5DiMlAnfBVl95NQrttcsdg,14834
 lusid/extensions/socket_keep_alive.py,sha256=eX5ICvGfVzUCGIm80Q2RknfFZrBQAdnrcpY61M29V_k,1997
 lusid/extensions/tcp_keep_alive_connector.py,sha256=zaGtUsygRsxB1_4B3x39K3ILwztdhMLDv5bFZV7zmGE,3877
-lusid/models/__init__.py,sha256=fhUZklfjKow6VE00-VUE1hykGWUQBdTcRPAUunIvG3w,137631
+lusid/models/__init__.py,sha256=ks7ExEQ6JU6tNW69v7erfHTuKjVKfN69vvUaAHJ0ekA,137991
 lusid/models/a2_b_breakdown.py,sha256=-FXgILrvtZXQDmvS0ARaJVGBq5LJ4AH-o3HjujFVmS4,3198
 lusid/models/a2_b_category.py,sha256=WunXUgx-dCnApPeLC8Qo5tVCX8Ywxkehib1vmNqNgNs,2957
 lusid/models/a2_b_data_record.py,sha256=qANTmV1_HUEo4l72-F8qzZjlQxOe0Onc9WPz7h-WWuY,9993
@@ -1220,7 +1220,10 @@ lusid/models/transaction_request.py,sha256=s6OVPLAxPDbUMU4gLN_XNX9ngdlKdPBgGeRDB
 lusid/models/transaction_roles.py,sha256=1r-BzcchffLl6p4lSUhRAUmsVdrl7Bvce2cCiwxJanE,839
 lusid/models/transaction_set_configuration_data.py,sha256=hgtBUJzYyJlOj11GTpTkY05Sqdcd4SdNY2gFhP3Zzis,4643
 lusid/models/transaction_set_configuration_data_request.py,sha256=Nq8DEDlONeOEJ_XHqKAcKaOlRibqrjfh06xo-RNQdbs,4179
-lusid/models/transaction_settlement_instruction.py,sha256=PKteV30g8tqydcB-qQ2xE6_6wS0AzS_ljQHPKOqri5c,6923
+lusid/models/transaction_settlement_bucket.py,sha256=dumOzhkFA3xI_KvKoGhXwAeP9qiEy_byo3Gxz3XPsdg,7141
+lusid/models/transaction_settlement_instruction.py,sha256=H4Tp2xRLf3BR6RBL5bKlDn4EHeE6Ei-Amy0eX_-f7jI,7343
+lusid/models/transaction_settlement_movement.py,sha256=gJ0hGansWYlriQhQnltje8AEEzXGCzxTCUD9Z0SiQFY,4374
+lusid/models/transaction_settlement_status.py,sha256=19MqHfQjVhuKw7aMMbWh6LlZ-dpTHYHbvMieZRmmGV0,5437
 lusid/models/transaction_status.py,sha256=8b1pF1I7A3PzeZmStCXvnhqcDsPSlo8fQnnNQFYGZlA,812
 lusid/models/transaction_template.py,sha256=mFZdjodcv7BQZEb4V0chCUiMc7mz_VgYF2CPppev3Fo,4351
 lusid/models/transaction_template_request.py,sha256=5zZKzBg5bl_1XWq4T9rO3HbzRfoQOYz3XDFH0OdXBeY,3088
@@ -1380,6 +1383,6 @@ lusid/models/year_month_day.py,sha256=gwSoxFwlD_wffKdddo1wfvAcLq3Cht3FHQidiaHzAA
 lusid/models/yield_curve_data.py,sha256=I1ZSWxHMgUxj9OQt6i9a4S91KB4_XtmrfFxpN_PV3YQ,9561
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=HQT__5LQEMu6_1sLKvYj-DI4FH1DJXBIPYfZCTTyrY4,13431
-lusid_sdk-2.1.921.dist-info/METADATA,sha256=lw3_uSTi7-PM39l-KsBQRXAwCTaqD5suxK6PTEjnjJA,231223
-lusid_sdk-2.1.921.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-lusid_sdk-2.1.921.dist-info/RECORD,,
+lusid_sdk-2.1.922.dist-info/METADATA,sha256=VXHhUlKfIAMnxhzKBtslDPCitcDGf__UBoNwv7xrqog,231791
+lusid_sdk-2.1.922.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+lusid_sdk-2.1.922.dist-info/RECORD,,