Source code for sdk.lusid.models.transaction_entity

# 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 List, Dict, Optional, Any, Union, TYPE_CHECKING
from typing_extensions import Annotated
from pydantic.v1 import BaseModel, StrictStr, StrictInt, StrictBool, StrictFloat, StrictBytes, Field, validator, ValidationError, conlist, constr
from datetime import datetime
from lusid.models.link import Link
from lusid.models.portfolio_without_href import PortfolioWithoutHref
from lusid.models.transaction import Transaction

[docs] class TransactionEntity(BaseModel): """ TransactionEntity """ href: StrictStr = Field(...,alias="href", description="The link to the transaction entity.") entity_unique_id: StrictStr = Field(...,alias="entityUniqueId", description="The unique id of the transaction, combining the portfolio and transaction identifiers.") as_at_version_number: Optional[StrictInt] = Field(default=None, description="The version number of the transaction entity at the requested asAt.", alias="asAtVersionNumber") status: StrictStr = Field(...,alias="status", description="The status of the transaction entity. 'Prevailing' when the transaction exists — including a cancelled transaction, whose cancellation is reflected in its own status rather than here; 'Deleted' when the transaction's portfolio has been deleted; 'DoesNotExist' when the transaction does not yet exist (e.g. staged creation preview). Available values: Prevailing, Deleted, DoesNotExist.") as_at_deleted: Optional[datetime] = Field(default=None, description="The asAt datetime at which the portfolio (and by extension, the transaction) was deleted.", alias="asAtDeleted") user_id_deleted: Optional[StrictStr] = Field(None,alias="userIdDeleted", description="The unique id of the user who deleted the portfolio.") request_id_deleted: Optional[StrictStr] = Field(None,alias="requestIdDeleted", description="The unique request id of the command that deleted the portfolio.") prevailing_portfolio: Optional[PortfolioWithoutHref] = Field(default=None, alias="prevailingPortfolio") prevailing_input_transaction: Optional[Transaction] = Field(default=None, alias="prevailingInputTransaction") deleted_portfolio: Optional[PortfolioWithoutHref] = Field(default=None, alias="deletedPortfolio") deleted_input_transaction: Optional[Transaction] = Field(default=None, alias="deletedInputTransaction") previewed_status: Optional[StrictStr] = Field(None,alias="previewedStatus", description="The status of the transaction after the staged modification is applied. Always 'Prevailing' for transaction previews. Available values: Prevailing, Deleted, DoesNotExist.") previewed_portfolio: Optional[PortfolioWithoutHref] = Field(default=None, alias="previewedPortfolio") previewed_input_transaction: Optional[Transaction] = Field(default=None, alias="previewedInputTransaction") links: Optional[List[Link]] = None __properties = ["href", "entityUniqueId", "asAtVersionNumber", "status", "asAtDeleted", "userIdDeleted", "requestIdDeleted", "prevailingPortfolio", "prevailingInputTransaction", "deletedPortfolio", "deletedInputTransaction", "previewedStatus", "previewedPortfolio", "previewedInputTransaction", "links"]
[docs] 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()
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.dict(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> TransactionEntity: """Create an instance of TransactionEntity from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] 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 prevailing_portfolio if self.prevailing_portfolio: _dict['prevailingPortfolio'] = self.prevailing_portfolio.to_dict() # override the default output from pydantic by calling `to_dict()` of prevailing_input_transaction if self.prevailing_input_transaction: _dict['prevailingInputTransaction'] = self.prevailing_input_transaction.to_dict() # override the default output from pydantic by calling `to_dict()` of deleted_portfolio if self.deleted_portfolio: _dict['deletedPortfolio'] = self.deleted_portfolio.to_dict() # override the default output from pydantic by calling `to_dict()` of deleted_input_transaction if self.deleted_input_transaction: _dict['deletedInputTransaction'] = self.deleted_input_transaction.to_dict() # override the default output from pydantic by calling `to_dict()` of previewed_portfolio if self.previewed_portfolio: _dict['previewedPortfolio'] = self.previewed_portfolio.to_dict() # override the default output from pydantic by calling `to_dict()` of previewed_input_transaction if self.previewed_input_transaction: _dict['previewedInputTransaction'] = self.previewed_input_transaction.to_dict() # 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 as_at_version_number (nullable) is None # and __fields_set__ contains the field if self.as_at_version_number is None and "as_at_version_number" in self.__fields_set__: _dict['asAtVersionNumber'] = None # set to None if as_at_deleted (nullable) is None # and __fields_set__ contains the field if self.as_at_deleted is None and "as_at_deleted" in self.__fields_set__: _dict['asAtDeleted'] = None # set to None if user_id_deleted (nullable) is None # and __fields_set__ contains the field if self.user_id_deleted is None and "user_id_deleted" in self.__fields_set__: _dict['userIdDeleted'] = None # set to None if request_id_deleted (nullable) is None # and __fields_set__ contains the field if self.request_id_deleted is None and "request_id_deleted" in self.__fields_set__: _dict['requestIdDeleted'] = None # set to None if previewed_status (nullable) is None # and __fields_set__ contains the field if self.previewed_status is None and "previewed_status" in self.__fields_set__: _dict['previewedStatus'] = 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
[docs] @classmethod def from_dict(cls, obj: dict) -> TransactionEntity: """Create an instance of TransactionEntity from a dict""" if obj is None: return None if not isinstance(obj, dict): return TransactionEntity.parse_obj(obj) _obj = TransactionEntity.parse_obj({ "href": obj.get("href"), "entity_unique_id": obj.get("entityUniqueId"), "as_at_version_number": obj.get("asAtVersionNumber"), "status": obj.get("status"), "as_at_deleted": obj.get("asAtDeleted"), "user_id_deleted": obj.get("userIdDeleted"), "request_id_deleted": obj.get("requestIdDeleted"), "prevailing_portfolio": PortfolioWithoutHref.from_dict(obj.get("prevailingPortfolio")) if obj.get("prevailingPortfolio") is not None else None, "prevailing_input_transaction": Transaction.from_dict(obj.get("prevailingInputTransaction")) if obj.get("prevailingInputTransaction") is not None else None, "deleted_portfolio": PortfolioWithoutHref.from_dict(obj.get("deletedPortfolio")) if obj.get("deletedPortfolio") is not None else None, "deleted_input_transaction": Transaction.from_dict(obj.get("deletedInputTransaction")) if obj.get("deletedInputTransaction") is not None else None, "previewed_status": obj.get("previewedStatus"), "previewed_portfolio": PortfolioWithoutHref.from_dict(obj.get("previewedPortfolio")) if obj.get("previewedPortfolio") is not None else None, "previewed_input_transaction": Transaction.from_dict(obj.get("previewedInputTransaction")) if obj.get("previewedInputTransaction") 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
TransactionEntity.update_forward_refs()