lusid-sdk 1.1.250__py3-none-any.whl → 2.0.455__py3-none-any.whl

lusid/models/transaction_type_movement.py

@@ -5,419 +5,142 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.250
     Contact: info@finbourne.com
-    Generated by: https://openapi-generator.tech
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
 """
 
 
-try:
-    from inspect import getfullargspec
-except ImportError:
-    from inspect import getargspec as getfullargspec
+from __future__ import annotations
 import pprint
 import re  # noqa: F401
-import six
-
-from lusid.configuration import Configuration
+import json
 
 
-class TransactionTypeMovement(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictInt, StrictStr, conlist, constr, validator
+from lusid.models.perpetual_property import PerpetualProperty
+from lusid.models.transaction_type_property_mapping import TransactionTypePropertyMapping
 
+class TransactionTypeMovement(BaseModel):
     """
-    Attributes:
-      openapi_types (dict): The key is attribute name
-                            and the value is attribute type.
-      attribute_map (dict): The key is attribute name
-                            and the value is json key in definition.
-      required_map (dict): The key is attribute name
-                           and the value is whether it is 'required' or 'optional'.
+    TransactionTypeMovement
     """
-    openapi_types = {
-        'movement_types': 'str',
-        'side': 'str',
-        'direction': 'int',
-        'properties': 'dict(str, PerpetualProperty)',
-        'mappings': 'list[TransactionTypePropertyMapping]',
-        'name': 'str',
-        'movement_options': 'list[str]',
-        'settlement_date_override': 'str',
-        'condition': 'str'
-    }
-
-    attribute_map = {
-        'movement_types': 'movementTypes',
-        'side': 'side',
-        'direction': 'direction',
-        'properties': 'properties',
-        'mappings': 'mappings',
-        'name': 'name',
-        'movement_options': 'movementOptions',
-        'settlement_date_override': 'settlementDateOverride',
-        'condition': 'condition'
-    }
-
-    required_map = {
-        'movement_types': 'required',
-        'side': 'required',
-        'direction': 'required',
-        'properties': 'optional',
-        'mappings': 'optional',
-        'name': 'optional',
-        'movement_options': 'optional',
-        'settlement_date_override': 'optional',
-        'condition': 'optional'
-    }
-
-    def __init__(self, movement_types=None, side=None, direction=None, properties=None, mappings=None, name=None, movement_options=None, settlement_date_override=None, condition=None, local_vars_configuration=None):  # noqa: E501
-        """TransactionTypeMovement - a model defined in OpenAPI"
-        
-        :param movement_types:  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, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee. (required)
-        :type movement_types: str
-        :param side:  The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration (required)
-        :type side: str
-        :param direction:   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 (required)
-        :type direction: int
-        :param properties:  The properties associated with the underlying Movement
-        :type properties: dict[str, lusid.PerpetualProperty]
-        :param mappings:  This allows you to map a transaction property to a property on the underlying holding
-        :type mappings: list[lusid.TransactionTypePropertyMapping]
-        :param name:  The movement name (optional)
-        :type name: str
-        :param movement_options:  Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.
-        :type movement_options: list[str]
-        :param settlement_date_override:  Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.
-        :type settlement_date_override: str
-        :param condition:  The condition that the transaction must satisfy to generate the movement, such as: Portfolio.BaseCurrency eq 'GBP'. The condition can contain fields and properties from transactions and portfolios. If no condition is provided, the movement will apply for all transactions of this type.
-        :type condition: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._movement_types = None
-        self._side = None
-        self._direction = None
-        self._properties = None
-        self._mappings = None
-        self._name = None
-        self._movement_options = None
-        self._settlement_date_override = None
-        self._condition = None
-        self.discriminator = None
-
-        self.movement_types = movement_types
-        self.side = side
-        self.direction = direction
-        self.properties = properties
-        self.mappings = mappings
-        self.name = name
-        self.movement_options = movement_options
-        self.settlement_date_override = settlement_date_override
-        self.condition = condition
-
-    @property
-    def movement_types(self):
-        """Gets the movement_types of this TransactionTypeMovement.  # noqa: E501
-
-        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, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee.  # noqa: E501
-
-        :return: The movement_types of this TransactionTypeMovement.  # noqa: E501
-        :rtype: str
-        """
-        return self._movement_types
-
-    @movement_types.setter
-    def movement_types(self, movement_types):
-        """Sets the movement_types of this TransactionTypeMovement.
-
-        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, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee.  # noqa: E501
-
-        :param movement_types: The movement_types of this TransactionTypeMovement.  # noqa: E501
-        :type movement_types: str
-        """
-        if self.local_vars_configuration.client_side_validation and movement_types is None:  # noqa: E501
-            raise ValueError("Invalid value for `movement_types`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                movement_types is not None and len(movement_types) < 1):
-            raise ValueError("Invalid value for `movement_types`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._movement_types = movement_types
-
-    @property
-    def side(self):
-        """Gets the side of this TransactionTypeMovement.  # noqa: E501
-
-        The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration  # noqa: E501
-
-        :return: The side of this TransactionTypeMovement.  # noqa: E501
-        :rtype: str
-        """
-        return self._side
-
-    @side.setter
-    def side(self, side):
-        """Sets the side of this TransactionTypeMovement.
-
-        The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration  # noqa: E501
-
-        :param side: The side of this TransactionTypeMovement.  # noqa: E501
-        :type side: str
-        """
-        if self.local_vars_configuration.client_side_validation and side is None:  # noqa: E501
-            raise ValueError("Invalid value for `side`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                side is not None and len(side) > 64):
-            raise ValueError("Invalid value for `side`, length must be less than or equal to `64`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                side is not None and len(side) < 1):
-            raise ValueError("Invalid value for `side`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                side is not None and not re.search(r'^[a-zA-Z0-9\-_]+$', side)):  # noqa: E501
-            raise ValueError(r"Invalid value for `side`, must be a follow pattern or equal to `/^[a-zA-Z0-9\-_]+$/`")  # noqa: E501
-
-        self._side = side
-
-    @property
-    def direction(self):
-        """Gets the direction of this TransactionTypeMovement.  # noqa: E501
-
-         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  # noqa: E501
-
-        :return: The direction of this TransactionTypeMovement.  # noqa: E501
-        :rtype: int
-        """
-        return self._direction
-
-    @direction.setter
-    def direction(self, direction):
-        """Sets the direction of this TransactionTypeMovement.
-
-         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  # noqa: E501
-
-        :param direction: The direction of this TransactionTypeMovement.  # noqa: E501
-        :type direction: int
-        """
-        if self.local_vars_configuration.client_side_validation and direction is None:  # noqa: E501
-            raise ValueError("Invalid value for `direction`, must not be `None`")  # noqa: E501
-
-        self._direction = direction
-
-    @property
-    def properties(self):
-        """Gets the properties of this TransactionTypeMovement.  # noqa: E501
-
-        The properties associated with the underlying Movement  # noqa: E501
-
-        :return: The properties of this TransactionTypeMovement.  # noqa: E501
-        :rtype: dict[str, lusid.PerpetualProperty]
-        """
-        return self._properties
-
-    @properties.setter
-    def properties(self, properties):
-        """Sets the properties of this TransactionTypeMovement.
-
-        The properties associated with the underlying Movement  # noqa: E501
-
-        :param properties: The properties of this TransactionTypeMovement.  # noqa: E501
-        :type properties: dict[str, lusid.PerpetualProperty]
-        """
-
-        self._properties = properties
-
-    @property
-    def mappings(self):
-        """Gets the mappings of this TransactionTypeMovement.  # noqa: E501
-
-        This allows you to map a transaction property to a property on the underlying holding  # noqa: E501
-
-        :return: The mappings of this TransactionTypeMovement.  # noqa: E501
-        :rtype: list[lusid.TransactionTypePropertyMapping]
-        """
-        return self._mappings
-
-    @mappings.setter
-    def mappings(self, mappings):
-        """Sets the mappings of this TransactionTypeMovement.
-
-        This allows you to map a transaction property to a property on the underlying holding  # noqa: E501
-
-        :param mappings: The mappings of this TransactionTypeMovement.  # noqa: E501
-        :type mappings: list[lusid.TransactionTypePropertyMapping]
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                mappings is not None and len(mappings) > 5000):
-            raise ValueError("Invalid value for `mappings`, number of items must be less than or equal to `5000`")  # noqa: E501
-
-        self._mappings = mappings
-
-    @property
-    def name(self):
-        """Gets the name of this TransactionTypeMovement.  # noqa: E501
-
-        The movement name (optional)  # noqa: E501
-
-        :return: The name of this TransactionTypeMovement.  # noqa: E501
-        :rtype: str
-        """
-        return self._name
-
-    @name.setter
-    def name(self, name):
-        """Sets the name of this TransactionTypeMovement.
-
-        The movement name (optional)  # noqa: E501
-
-        :param name: The name of this TransactionTypeMovement.  # noqa: E501
-        :type name: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                name is not None and len(name) > 512):
-            raise ValueError("Invalid value for `name`, length must be less than or equal to `512`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                name is not None and len(name) < 1):
-            raise ValueError("Invalid value for `name`, length must be greater than or equal to `1`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                name is not None and not re.search(r'^[\s\S]*$', name)):  # noqa: E501
-            raise ValueError(r"Invalid value for `name`, must be a follow pattern or equal to `/^[\s\S]*$/`")  # noqa: E501
-
-        self._name = name
-
-    @property
-    def movement_options(self):
-        """Gets the movement_options of this TransactionTypeMovement.  # noqa: E501
-
-        Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.  # noqa: E501
-
-        :return: The movement_options of this TransactionTypeMovement.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._movement_options
-
-    @movement_options.setter
-    def movement_options(self, movement_options):
-        """Sets the movement_options of this TransactionTypeMovement.
-
-        Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.  # noqa: E501
-
-        :param movement_options: The movement_options of this TransactionTypeMovement.  # noqa: E501
-        :type movement_options: list[str]
-        """
-
-        self._movement_options = movement_options
-
-    @property
-    def settlement_date_override(self):
-        """Gets the settlement_date_override of this TransactionTypeMovement.  # noqa: E501
-
-        Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.  # noqa: E501
-
-        :return: The settlement_date_override of this TransactionTypeMovement.  # noqa: E501
-        :rtype: str
-        """
-        return self._settlement_date_override
-
-    @settlement_date_override.setter
-    def settlement_date_override(self, settlement_date_override):
-        """Sets the settlement_date_override of this TransactionTypeMovement.
-
-        Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.  # noqa: E501
-
-        :param settlement_date_override: The settlement_date_override of this TransactionTypeMovement.  # noqa: E501
-        :type settlement_date_override: str
-        """
-
-        self._settlement_date_override = settlement_date_override
-
-    @property
-    def condition(self):
-        """Gets the condition of this TransactionTypeMovement.  # noqa: E501
-
-        The condition that the transaction must satisfy to generate the movement, such as: Portfolio.BaseCurrency eq 'GBP'. The condition can contain fields and properties from transactions and portfolios. If no condition is provided, the movement will apply for all transactions of this type.  # noqa: E501
-
-        :return: The condition of this TransactionTypeMovement.  # noqa: E501
-        :rtype: str
-        """
-        return self._condition
-
-    @condition.setter
-    def condition(self, condition):
-        """Sets the condition of this TransactionTypeMovement.
-
-        The condition that the transaction must satisfy to generate the movement, such as: Portfolio.BaseCurrency eq 'GBP'. The condition can contain fields and properties from transactions and portfolios. If no condition is provided, the movement will apply for all transactions of this type.  # noqa: E501
-
-        :param condition: The condition of this TransactionTypeMovement.  # noqa: E501
-        :type condition: str
-        """
-        if (self.local_vars_configuration.client_side_validation and
-                condition is not None and len(condition) > 16384):
-            raise ValueError("Invalid value for `condition`, length must be less than or equal to `16384`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                condition is not None and len(condition) < 0):
-            raise ValueError("Invalid value for `condition`, length must be greater than or equal to `0`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                condition is not None and not re.search(r'^[\s\S]*$', condition)):  # noqa: E501
-            raise ValueError(r"Invalid value for `condition`, must be a follow pattern or equal to `/^[\s\S]*$/`")  # noqa: E501
-
-        self._condition = condition
-
-    def to_dict(self, serialize=False):
-        """Returns the model properties as a dict"""
-        result = {}
-
-        def convert(x):
-            if hasattr(x, "to_dict"):
-                args = getfullargspec(x.to_dict).args
-                if len(args) == 1:
-                    return x.to_dict()
-                else:
-                    return x.to_dict(serialize)
-            else:
-                return x
-
-        for attr, _ in six.iteritems(self.openapi_types):
-            value = getattr(self, attr)
-            attr = self.attribute_map.get(attr, attr) if serialize else attr
-            if isinstance(value, list):
-                result[attr] = list(map(
-                    lambda x: convert(x),
-                    value
-                ))
-            elif isinstance(value, dict):
-                result[attr] = dict(map(
-                    lambda item: (item[0], convert(item[1])),
-                    value.items()
-                ))
-            else:
-                result[attr] = convert(value)
-
-        return result
-
-    def to_str(self):
-        """Returns the string representation of the model"""
-        return pprint.pformat(self.to_dict())
-
-    def __repr__(self):
-        """For `print` and `pprint`"""
-        return self.to_str()
-
-    def __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, TransactionTypeMovement):
-            return False
-
-        return self.to_dict() == other.to_dict()
-
-    def __ne__(self, other):
-        """Returns true if both objects are not equal"""
-        if not isinstance(other, TransactionTypeMovement):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    movement_types: constr(strict=True, min_length=1) = Field(..., alias="movementTypes", description="Movement types determine the impact of the movement on the holdings")
+    side: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration")
+    direction: StrictInt = Field(..., 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")
+    properties: Optional[Dict[str, PerpetualProperty]] = Field(None, description="The properties associated with the underlying Movement")
+    mappings: Optional[conlist(TransactionTypePropertyMapping, max_items=5000)] = Field(None, description="This allows you to map a transaction property to a property on the underlying holding")
+    name: Optional[constr(strict=True, max_length=512, min_length=1)] = Field(None, description="The movement name (optional)")
+    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The only option currently available is 'DirectAdjustment'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the unitsof a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
+    settlement_date_override: Optional[StrictStr] = Field(None, alias="settlementDateOverride", description="Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.")
+    __properties = ["movementTypes", "side", "direction", "properties", "mappings", "name", "movementOptions", "settlementDateOverride"]
+
+    @validator('side')
+    def side_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('name')
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[\s\S]*$", value):
+            raise ValueError(r"must validate the regular expression /^[\s\S]*$/")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    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) -> TransactionTypeMovement:
+        """Create an instance of TransactionTypeMovement 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 value in properties (dict)
+        _field_dict = {}
+        if self.properties:
+            for _key in self.properties:
+                if self.properties[_key]:
+                    _field_dict[_key] = self.properties[_key].to_dict()
+            _dict['properties'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each item in mappings (list)
+        _items = []
+        if self.mappings:
+            for _item in self.mappings:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['mappings'] = _items
+        # set to None if properties (nullable) is None
+        # and __fields_set__ contains the field
+        if self.properties is None and "properties" in self.__fields_set__:
+            _dict['properties'] = None
+
+        # set to None if mappings (nullable) is None
+        # and __fields_set__ contains the field
+        if self.mappings is None and "mappings" in self.__fields_set__:
+            _dict['mappings'] = None
+
+        # 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 movement_options (nullable) is None
+        # and __fields_set__ contains the field
+        if self.movement_options is None and "movement_options" in self.__fields_set__:
+            _dict['movementOptions'] = None
+
+        # set to None if settlement_date_override (nullable) is None
+        # and __fields_set__ contains the field
+        if self.settlement_date_override is None and "settlement_date_override" in self.__fields_set__:
+            _dict['settlementDateOverride'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionTypeMovement:
+        """Create an instance of TransactionTypeMovement from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionTypeMovement.parse_obj(obj)
+
+        _obj = TransactionTypeMovement.parse_obj({
+            "movement_types": obj.get("movementTypes"),
+            "side": obj.get("side"),
+            "direction": obj.get("direction"),
+            "properties": dict(
+                (_k, PerpetualProperty.from_dict(_v))
+                for _k, _v in obj.get("properties").items()
+            )
+            if obj.get("properties") is not None
+            else None,
+            "mappings": [TransactionTypePropertyMapping.from_dict(_item) for _item in obj.get("mappings")] if obj.get("mappings") is not None else None,
+            "name": obj.get("name"),
+            "movement_options": obj.get("movementOptions"),
+            "settlement_date_override": obj.get("settlementDateOverride")
+        })
+        return _obj