lusid-sdk 1.1.118__py3-none-any.whl → 2.0.50b0__py3-none-any.whl

lusid/models/transaction_reconciliation_request.py

@@ -5,315 +5,97 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.118
     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
 
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from pydantic import BaseModel, Field, StrictStr, conlist
+from lusid.models.resource_id import ResourceId
 
-class TransactionReconciliationRequest(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
+class TransactionReconciliationRequest(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'.
+    Specifies the parameter to be use when performing a Transaction Reconciliation.  # noqa: E501
     """
-    openapi_types = {
-        'left_portfolio_id': 'ResourceId',
-        'right_portfolio_id': 'ResourceId',
-        'mapping_id': 'ResourceId',
-        'from_transaction_date': 'datetime',
-        'to_transaction_date': 'datetime',
-        'as_at': 'datetime',
-        'property_keys': 'list[str]'
-    }
-
-    attribute_map = {
-        'left_portfolio_id': 'leftPortfolioId',
-        'right_portfolio_id': 'rightPortfolioId',
-        'mapping_id': 'mappingId',
-        'from_transaction_date': 'fromTransactionDate',
-        'to_transaction_date': 'toTransactionDate',
-        'as_at': 'asAt',
-        'property_keys': 'propertyKeys'
-    }
-
-    required_map = {
-        'left_portfolio_id': 'required',
-        'right_portfolio_id': 'required',
-        'mapping_id': 'optional',
-        'from_transaction_date': 'required',
-        'to_transaction_date': 'required',
-        'as_at': 'optional',
-        'property_keys': 'optional'
-    }
-
-    def __init__(self, left_portfolio_id=None, right_portfolio_id=None, mapping_id=None, from_transaction_date=None, to_transaction_date=None, as_at=None, property_keys=None, local_vars_configuration=None):  # noqa: E501
-        """TransactionReconciliationRequest - a model defined in OpenAPI"
-        
-        :param left_portfolio_id:  (required)
-        :type left_portfolio_id: lusid.ResourceId
-        :param right_portfolio_id:  (required)
-        :type right_portfolio_id: lusid.ResourceId
-        :param mapping_id: 
-        :type mapping_id: lusid.ResourceId
-        :param from_transaction_date:  (required)
-        :type from_transaction_date: datetime
-        :param to_transaction_date:  (required)
-        :type to_transaction_date: datetime
-        :param as_at: 
-        :type as_at: datetime
-        :param property_keys: 
-        :type property_keys: list[str]
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._left_portfolio_id = None
-        self._right_portfolio_id = None
-        self._mapping_id = None
-        self._from_transaction_date = None
-        self._to_transaction_date = None
-        self._as_at = None
-        self._property_keys = None
-        self.discriminator = None
-
-        self.left_portfolio_id = left_portfolio_id
-        self.right_portfolio_id = right_portfolio_id
-        if mapping_id is not None:
-            self.mapping_id = mapping_id
-        self.from_transaction_date = from_transaction_date
-        self.to_transaction_date = to_transaction_date
-        self.as_at = as_at
-        self.property_keys = property_keys
-
-    @property
-    def left_portfolio_id(self):
-        """Gets the left_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The left_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._left_portfolio_id
-
-    @left_portfolio_id.setter
-    def left_portfolio_id(self, left_portfolio_id):
-        """Sets the left_portfolio_id of this TransactionReconciliationRequest.
-
-
-        :param left_portfolio_id: The left_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-        :type left_portfolio_id: lusid.ResourceId
-        """
-        if self.local_vars_configuration.client_side_validation and left_portfolio_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `left_portfolio_id`, must not be `None`")  # noqa: E501
-
-        self._left_portfolio_id = left_portfolio_id
-
-    @property
-    def right_portfolio_id(self):
-        """Gets the right_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The right_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._right_portfolio_id
-
-    @right_portfolio_id.setter
-    def right_portfolio_id(self, right_portfolio_id):
-        """Sets the right_portfolio_id of this TransactionReconciliationRequest.
-
-
-        :param right_portfolio_id: The right_portfolio_id of this TransactionReconciliationRequest.  # noqa: E501
-        :type right_portfolio_id: lusid.ResourceId
-        """
-        if self.local_vars_configuration.client_side_validation and right_portfolio_id is None:  # noqa: E501
-            raise ValueError("Invalid value for `right_portfolio_id`, must not be `None`")  # noqa: E501
-
-        self._right_portfolio_id = right_portfolio_id
-
-    @property
-    def mapping_id(self):
-        """Gets the mapping_id of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The mapping_id of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: lusid.ResourceId
-        """
-        return self._mapping_id
-
-    @mapping_id.setter
-    def mapping_id(self, mapping_id):
-        """Sets the mapping_id of this TransactionReconciliationRequest.
-
-
-        :param mapping_id: The mapping_id of this TransactionReconciliationRequest.  # noqa: E501
-        :type mapping_id: lusid.ResourceId
-        """
-
-        self._mapping_id = mapping_id
-
-    @property
-    def from_transaction_date(self):
-        """Gets the from_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The from_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._from_transaction_date
-
-    @from_transaction_date.setter
-    def from_transaction_date(self, from_transaction_date):
-        """Sets the from_transaction_date of this TransactionReconciliationRequest.
-
-
-        :param from_transaction_date: The from_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-        :type from_transaction_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and from_transaction_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `from_transaction_date`, must not be `None`")  # noqa: E501
-
-        self._from_transaction_date = from_transaction_date
-
-    @property
-    def to_transaction_date(self):
-        """Gets the to_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The to_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._to_transaction_date
-
-    @to_transaction_date.setter
-    def to_transaction_date(self, to_transaction_date):
-        """Sets the to_transaction_date of this TransactionReconciliationRequest.
-
-
-        :param to_transaction_date: The to_transaction_date of this TransactionReconciliationRequest.  # noqa: E501
-        :type to_transaction_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and to_transaction_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `to_transaction_date`, must not be `None`")  # noqa: E501
-
-        self._to_transaction_date = to_transaction_date
-
-    @property
-    def as_at(self):
-        """Gets the as_at of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The as_at of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._as_at
-
-    @as_at.setter
-    def as_at(self, as_at):
-        """Sets the as_at of this TransactionReconciliationRequest.
-
-
-        :param as_at: The as_at of this TransactionReconciliationRequest.  # noqa: E501
-        :type as_at: datetime
-        """
-
-        self._as_at = as_at
-
-    @property
-    def property_keys(self):
-        """Gets the property_keys of this TransactionReconciliationRequest.  # noqa: E501
-
-
-        :return: The property_keys of this TransactionReconciliationRequest.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._property_keys
-
-    @property_keys.setter
-    def property_keys(self, property_keys):
-        """Sets the property_keys of this TransactionReconciliationRequest.
-
-
-        :param property_keys: The property_keys of this TransactionReconciliationRequest.  # noqa: E501
-        :type property_keys: list[str]
-        """
-
-        self._property_keys = property_keys
-
-    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, TransactionReconciliationRequest):
-            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, TransactionReconciliationRequest):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    left_portfolio_id: ResourceId = Field(..., alias="leftPortfolioId")
+    right_portfolio_id: ResourceId = Field(..., alias="rightPortfolioId")
+    mapping_id: Optional[ResourceId] = Field(None, alias="mappingId")
+    from_transaction_date: datetime = Field(..., alias="fromTransactionDate")
+    to_transaction_date: datetime = Field(..., alias="toTransactionDate")
+    as_at: Optional[datetime] = Field(None, alias="asAt")
+    property_keys: Optional[conlist(StrictStr)] = Field(None, alias="propertyKeys")
+    __properties = ["leftPortfolioId", "rightPortfolioId", "mappingId", "fromTransactionDate", "toTransactionDate", "asAt", "propertyKeys"]
+
+    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) -> TransactionReconciliationRequest:
+        """Create an instance of TransactionReconciliationRequest 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 left_portfolio_id
+        if self.left_portfolio_id:
+            _dict['leftPortfolioId'] = self.left_portfolio_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right_portfolio_id
+        if self.right_portfolio_id:
+            _dict['rightPortfolioId'] = self.right_portfolio_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of mapping_id
+        if self.mapping_id:
+            _dict['mappingId'] = self.mapping_id.to_dict()
+        # set to None if as_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.as_at is None and "as_at" in self.__fields_set__:
+            _dict['asAt'] = None
+
+        # set to None if property_keys (nullable) is None
+        # and __fields_set__ contains the field
+        if self.property_keys is None and "property_keys" in self.__fields_set__:
+            _dict['propertyKeys'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionReconciliationRequest:
+        """Create an instance of TransactionReconciliationRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionReconciliationRequest.parse_obj(obj)
+
+        _obj = TransactionReconciliationRequest.parse_obj({
+            "left_portfolio_id": ResourceId.from_dict(obj.get("leftPortfolioId")) if obj.get("leftPortfolioId") is not None else None,
+            "right_portfolio_id": ResourceId.from_dict(obj.get("rightPortfolioId")) if obj.get("rightPortfolioId") is not None else None,
+            "mapping_id": ResourceId.from_dict(obj.get("mappingId")) if obj.get("mappingId") is not None else None,
+            "from_transaction_date": obj.get("fromTransactionDate"),
+            "to_transaction_date": obj.get("toTransactionDate"),
+            "as_at": obj.get("asAt"),
+            "property_keys": obj.get("propertyKeys")
+        })
+        return _obj

lusid/models/transaction_reconciliation_request_v2.py

@@ -0,0 +1,115 @@
+# 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 import BaseModel, Field, StrictStr, conlist
+from lusid.models.aggregated_transactions_request import AggregatedTransactionsRequest
+from lusid.models.reconciliation_left_right_address_key_pair import ReconciliationLeftRightAddressKeyPair
+from lusid.models.reconciliation_rule import ReconciliationRule
+
+class TransactionReconciliationRequestV2(BaseModel):
+    """
+    Specification for the reconciliation request. Left and Right hand sides are constructed. Each consists of transactions from a portfolio  The results of this can then be compared to each other.  # noqa: E501
+    """
+    left: AggregatedTransactionsRequest = Field(...)
+    right: AggregatedTransactionsRequest = Field(...)
+    left_to_right_mapping: Optional[conlist(ReconciliationLeftRightAddressKeyPair)] = Field(None, alias="leftToRightMapping", description="The mapping from property keys requested by left aggregation to property keys on right hand side")
+    comparison_rules: Optional[conlist(ReconciliationRule)] = Field(None, alias="comparisonRules", description="The set of rules to be used in comparing values. These are the rules that determine what constitutes a match.  The simplest is obviously an exact one-for-one comparison, but tolerances on numerical or date time values and  case-insensitive string comparison are supported amongst other types.")
+    preserve_keys: Optional[conlist(StrictStr)] = Field(None, alias="preserveKeys", description="List of keys to preserve (from rhs) in the diff. Used in conjunction with filtering/grouping.  If two values are equal, for a given key then the value is elided from the results. Setting it here  will preserve it (takes the values from the RHS and puts it into the line by line results).")
+    __properties = ["left", "right", "leftToRightMapping", "comparisonRules", "preserveKeys"]
+
+    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) -> TransactionReconciliationRequestV2:
+        """Create an instance of TransactionReconciliationRequestV2 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 left
+        if self.left:
+            _dict['left'] = self.left.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of right
+        if self.right:
+            _dict['right'] = self.right.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in left_to_right_mapping (list)
+        _items = []
+        if self.left_to_right_mapping:
+            for _item in self.left_to_right_mapping:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['leftToRightMapping'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in comparison_rules (list)
+        _items = []
+        if self.comparison_rules:
+            for _item in self.comparison_rules:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['comparisonRules'] = _items
+        # set to None if left_to_right_mapping (nullable) is None
+        # and __fields_set__ contains the field
+        if self.left_to_right_mapping is None and "left_to_right_mapping" in self.__fields_set__:
+            _dict['leftToRightMapping'] = None
+
+        # set to None if comparison_rules (nullable) is None
+        # and __fields_set__ contains the field
+        if self.comparison_rules is None and "comparison_rules" in self.__fields_set__:
+            _dict['comparisonRules'] = None
+
+        # set to None if preserve_keys (nullable) is None
+        # and __fields_set__ contains the field
+        if self.preserve_keys is None and "preserve_keys" in self.__fields_set__:
+            _dict['preserveKeys'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> TransactionReconciliationRequestV2:
+        """Create an instance of TransactionReconciliationRequestV2 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return TransactionReconciliationRequestV2.parse_obj(obj)
+
+        _obj = TransactionReconciliationRequestV2.parse_obj({
+            "left": AggregatedTransactionsRequest.from_dict(obj.get("left")) if obj.get("left") is not None else None,
+            "right": AggregatedTransactionsRequest.from_dict(obj.get("right")) if obj.get("right") is not None else None,
+            "left_to_right_mapping": [ReconciliationLeftRightAddressKeyPair.from_dict(_item) for _item in obj.get("leftToRightMapping")] if obj.get("leftToRightMapping") is not None else None,
+            "comparison_rules": [ReconciliationRule.from_dict(_item) for _item in obj.get("comparisonRules")] if obj.get("comparisonRules") is not None else None,
+            "preserve_keys": obj.get("preserveKeys")
+        })
+        return _obj