lusid-sdk 1.1.131__py3-none-any.whl → 2.1.683__py3-none-any.whl

lusid/models/amortisation_event.py

@@ -5,279 +5,101 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.131
     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 AmortisationEvent(object):
-    """NOTE: This class is auto generated by OpenAPI Generator.
-    Ref: https://openapi-generator.tech
-
-    Do not edit the class manually.
-    """
+from datetime import datetime
+from typing import Any, Dict, Union
+from pydantic.v1 import Field, StrictFloat, StrictInt, StrictStr, constr, validator
+from lusid.models.instrument_event import InstrumentEvent
 
+class AmortisationEvent(InstrumentEvent):
     """
-    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'.
+    Definition of an Amortisation event.  This is an event that describes the occurence of amortisation.  # noqa: E501
     """
-    openapi_types = {
-        'amount_reduced': 'float',
-        'dom_ccy': 'str',
-        'pay_receive': 'str',
-        'payment_date': 'datetime',
-        'instrument_event_type': 'str'
-    }
-
-    attribute_map = {
-        'amount_reduced': 'amountReduced',
-        'dom_ccy': 'domCcy',
-        'pay_receive': 'payReceive',
-        'payment_date': 'paymentDate',
-        'instrument_event_type': 'instrumentEventType'
-    }
-
-    required_map = {
-        'amount_reduced': 'required',
-        'dom_ccy': 'required',
-        'pay_receive': 'required',
-        'payment_date': 'required',
-        'instrument_event_type': 'required'
-    }
-
-    def __init__(self, amount_reduced=None, dom_ccy=None, pay_receive=None, payment_date=None, instrument_event_type=None, local_vars_configuration=None):  # noqa: E501
-        """AmortisationEvent - a model defined in OpenAPI"
-        
-        :param amount_reduced:  The amount reduced in this amortisation event.  That is, the difference between the previous notional amount and the current notional amount as set in this event. (required)
-        :type amount_reduced: float
-        :param dom_ccy:  Domestic currency of the originating instrument (required)
-        :type dom_ccy: str
-        :param pay_receive:  Is this event in relation to the Pay or Receive leg (required)
-        :type pay_receive: str
-        :param payment_date:  The date the principal payment is to be made. (required)
-        :type payment_date: datetime
-        :param instrument_event_type:  The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required)
-        :type instrument_event_type: str
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._amount_reduced = None
-        self._dom_ccy = None
-        self._pay_receive = None
-        self._payment_date = None
-        self._instrument_event_type = None
-        self.discriminator = None
-
-        self.amount_reduced = amount_reduced
-        self.dom_ccy = dom_ccy
-        self.pay_receive = pay_receive
-        self.payment_date = payment_date
-        self.instrument_event_type = instrument_event_type
-
-    @property
-    def amount_reduced(self):
-        """Gets the amount_reduced of this AmortisationEvent.  # noqa: E501
-
-        The amount reduced in this amortisation event.  That is, the difference between the previous notional amount and the current notional amount as set in this event.  # noqa: E501
-
-        :return: The amount_reduced of this AmortisationEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._amount_reduced
-
-    @amount_reduced.setter
-    def amount_reduced(self, amount_reduced):
-        """Sets the amount_reduced of this AmortisationEvent.
-
-        The amount reduced in this amortisation event.  That is, the difference between the previous notional amount and the current notional amount as set in this event.  # noqa: E501
-
-        :param amount_reduced: The amount_reduced of this AmortisationEvent.  # noqa: E501
-        :type amount_reduced: float
-        """
-        if self.local_vars_configuration.client_side_validation and amount_reduced is None:  # noqa: E501
-            raise ValueError("Invalid value for `amount_reduced`, must not be `None`")  # noqa: E501
-
-        self._amount_reduced = amount_reduced
-
-    @property
-    def dom_ccy(self):
-        """Gets the dom_ccy of this AmortisationEvent.  # noqa: E501
-
-        Domestic currency of the originating instrument  # noqa: E501
-
-        :return: The dom_ccy of this AmortisationEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._dom_ccy
-
-    @dom_ccy.setter
-    def dom_ccy(self, dom_ccy):
-        """Sets the dom_ccy of this AmortisationEvent.
-
-        Domestic currency of the originating instrument  # noqa: E501
-
-        :param dom_ccy: The dom_ccy of this AmortisationEvent.  # noqa: E501
-        :type dom_ccy: str
-        """
-        if self.local_vars_configuration.client_side_validation and dom_ccy is None:  # noqa: E501
-            raise ValueError("Invalid value for `dom_ccy`, must not be `None`")  # noqa: E501
-
-        self._dom_ccy = dom_ccy
-
-    @property
-    def pay_receive(self):
-        """Gets the pay_receive of this AmortisationEvent.  # noqa: E501
-
-        Is this event in relation to the Pay or Receive leg  # noqa: E501
-
-        :return: The pay_receive of this AmortisationEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._pay_receive
-
-    @pay_receive.setter
-    def pay_receive(self, pay_receive):
-        """Sets the pay_receive of this AmortisationEvent.
-
-        Is this event in relation to the Pay or Receive leg  # noqa: E501
-
-        :param pay_receive: The pay_receive of this AmortisationEvent.  # noqa: E501
-        :type pay_receive: str
-        """
-        if self.local_vars_configuration.client_side_validation and pay_receive is None:  # noqa: E501
-            raise ValueError("Invalid value for `pay_receive`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                pay_receive is not None and len(pay_receive) < 1):
-            raise ValueError("Invalid value for `pay_receive`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._pay_receive = pay_receive
-
-    @property
-    def payment_date(self):
-        """Gets the payment_date of this AmortisationEvent.  # noqa: E501
-
-        The date the principal payment is to be made.  # noqa: E501
-
-        :return: The payment_date of this AmortisationEvent.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._payment_date
-
-    @payment_date.setter
-    def payment_date(self, payment_date):
-        """Sets the payment_date of this AmortisationEvent.
-
-        The date the principal payment is to be made.  # noqa: E501
-
-        :param payment_date: The payment_date of this AmortisationEvent.  # noqa: E501
-        :type payment_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and payment_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `payment_date`, must not be `None`")  # noqa: E501
-
-        self._payment_date = payment_date
-
-    @property
-    def instrument_event_type(self):
-        """Gets the instrument_event_type of this AmortisationEvent.  # noqa: E501
-
-        The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent  # noqa: E501
-
-        :return: The instrument_event_type of this AmortisationEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_event_type
-
-    @instrument_event_type.setter
-    def instrument_event_type(self, instrument_event_type):
-        """Sets the instrument_event_type of this AmortisationEvent.
-
-        The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent  # noqa: E501
-
-        :param instrument_event_type: The instrument_event_type of this AmortisationEvent.  # noqa: E501
-        :type instrument_event_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and instrument_event_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `instrument_event_type`, must not be `None`")  # noqa: E501
-        allowed_values = ["TransitionEvent", "InformationalEvent", "OpenEvent", "CloseEvent", "StockSplitEvent", "BondDefaultEvent", "CashDividendEvent", "AmortisationEvent", "CashFlowEvent", "ExerciseEvent", "ResetEvent", "TriggerEvent", "RawVendorEvent", "InformationalErrorEvent", "BondCouponEvent", "DividendReinvestmentEvent", "AccumulationEvent", "BondPrincipalEvent", "DividendOptionEvent", "MaturityEvent", "FxForwardSettlementEvent", "ExpiryEvent", "ScripDividendEvent", "StockDividendEvent", "ReverseStockSplitEvent"]  # noqa: E501
-        if self.local_vars_configuration.client_side_validation and instrument_event_type not in allowed_values:  # noqa: E501
-            raise ValueError(
-                "Invalid value for `instrument_event_type` ({0}), must be one of {1}"  # noqa: E501
-                .format(instrument_event_type, allowed_values)
-            )
-
-        self._instrument_event_type = instrument_event_type
-
-    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())
+    amount_reduced: Union[StrictFloat, StrictInt] = Field(..., alias="amountReduced", description="The amount reduced in this amortisation event.  That is, the difference between the previous notional amount and the current notional amount as set in this event.")
+    dom_ccy: StrictStr = Field(..., alias="domCcy", description="Domestic currency of the originating instrument")
+    pay_receive: constr(strict=True, min_length=1) = Field(..., alias="payReceive", description="Is this event in relation to the Pay or Receive leg")
+    payment_date: datetime = Field(..., alias="paymentDate", description="The date the principal payment is to be made.")
+    instrument_event_type: StrictStr = Field(..., alias="instrumentEventType", description="The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent")
+    additional_properties: Dict[str, Any] = {}
+    __properties = ["instrumentEventType", "amountReduced", "domCcy", "payReceive", "paymentDate"]
+
+    @validator('instrument_event_type')
+    def instrument_event_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('TransitionEvent', 'InformationalEvent', 'OpenEvent', 'CloseEvent', 'StockSplitEvent', 'BondDefaultEvent', 'CashDividendEvent', 'AmortisationEvent', 'CashFlowEvent', 'ExerciseEvent', 'ResetEvent', 'TriggerEvent', 'RawVendorEvent', 'InformationalErrorEvent', 'BondCouponEvent', 'DividendReinvestmentEvent', 'AccumulationEvent', 'BondPrincipalEvent', 'DividendOptionEvent', 'MaturityEvent', 'FxForwardSettlementEvent', 'ExpiryEvent', 'ScripDividendEvent', 'StockDividendEvent', 'ReverseStockSplitEvent', 'CapitalDistributionEvent', 'SpinOffEvent', 'MergerEvent', 'FutureExpiryEvent', 'SwapCashFlowEvent', 'SwapPrincipalEvent', 'CreditPremiumCashFlowEvent', 'CdsCreditEvent', 'CdxCreditEvent', 'MbsCouponEvent', 'MbsPrincipalEvent', 'BonusIssueEvent', 'MbsPrincipalWriteOffEvent', 'MbsInterestDeferralEvent', 'MbsInterestShortfallEvent', 'TenderEvent', 'CallOnIntermediateSecuritiesEvent', 'IntermediateSecuritiesDistributionEvent', 'OptionExercisePhysicalEvent', 'OptionExerciseCashEvent', 'ProtectionPayoutCashFlowEvent', 'TermDepositInterestEvent', 'TermDepositPrincipalEvent', 'EarlyRedemptionEvent', 'FutureMarkToMarketEvent', 'AdjustGlobalCommitmentEvent', 'ContractInitialisationEvent', 'DrawdownEvent', 'LoanInterestRepaymentEvent'):
+            raise ValueError("must be one of enum values ('TransitionEvent', 'InformationalEvent', 'OpenEvent', 'CloseEvent', 'StockSplitEvent', 'BondDefaultEvent', 'CashDividendEvent', 'AmortisationEvent', 'CashFlowEvent', 'ExerciseEvent', 'ResetEvent', 'TriggerEvent', 'RawVendorEvent', 'InformationalErrorEvent', 'BondCouponEvent', 'DividendReinvestmentEvent', 'AccumulationEvent', 'BondPrincipalEvent', 'DividendOptionEvent', 'MaturityEvent', 'FxForwardSettlementEvent', 'ExpiryEvent', 'ScripDividendEvent', 'StockDividendEvent', 'ReverseStockSplitEvent', 'CapitalDistributionEvent', 'SpinOffEvent', 'MergerEvent', 'FutureExpiryEvent', 'SwapCashFlowEvent', 'SwapPrincipalEvent', 'CreditPremiumCashFlowEvent', 'CdsCreditEvent', 'CdxCreditEvent', 'MbsCouponEvent', 'MbsPrincipalEvent', 'BonusIssueEvent', 'MbsPrincipalWriteOffEvent', 'MbsInterestDeferralEvent', 'MbsInterestShortfallEvent', 'TenderEvent', 'CallOnIntermediateSecuritiesEvent', 'IntermediateSecuritiesDistributionEvent', 'OptionExercisePhysicalEvent', 'OptionExerciseCashEvent', 'ProtectionPayoutCashFlowEvent', 'TermDepositInterestEvent', 'TermDepositPrincipalEvent', 'EarlyRedemptionEvent', 'FutureMarkToMarketEvent', 'AdjustGlobalCommitmentEvent', 'ContractInitialisationEvent', 'DrawdownEvent', 'LoanInterestRepaymentEvent')")
+        return value
+
+    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 __eq__(self, other):
-        """Returns true if both objects are equal"""
-        if not isinstance(other, AmortisationEvent):
-            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, AmortisationEvent):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    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) -> AmortisationEvent:
+        """Create an instance of AmortisationEvent 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={
+                            "additional_properties"
+                          },
+                          exclude_none=True)
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AmortisationEvent:
+        """Create an instance of AmortisationEvent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AmortisationEvent.parse_obj(obj)
+
+        _obj = AmortisationEvent.parse_obj({
+            "instrument_event_type": obj.get("instrumentEventType"),
+            "amount_reduced": obj.get("amountReduced"),
+            "dom_ccy": obj.get("domCcy"),
+            "pay_receive": obj.get("payReceive"),
+            "payment_date": obj.get("paymentDate")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

lusid/models/amortisation_rule.py

@@ -0,0 +1,112 @@
+# 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
+from pydantic.v1 import BaseModel, Field, constr, validator
+
+class AmortisationRule(BaseModel):
+    """
+    AmortisationRule
+    """
+    name: constr(strict=True, max_length=256, min_length=1) = Field(..., description="The name of the rule.")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="A description of the rule.")
+    filter: constr(strict=True, max_length=16384, min_length=0) = Field(..., description="The filter for this rule.")
+    amortisation_method: constr(strict=True, min_length=1) = Field(..., alias="amortisationMethod", description="The filter for this rule.")
+    __properties = ["name", "description", "filter", "amortisationMethod"]
+
+    @validator('name')
+    def name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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
+
+    @validator('filter')
+    def filter_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        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 __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) -> AmortisationRule:
+        """Create an instance of AmortisationRule 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 description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> AmortisationRule:
+        """Create an instance of AmortisationRule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AmortisationRule.parse_obj(obj)
+
+        _obj = AmortisationRule.parse_obj({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "filter": obj.get("filter"),
+            "amortisation_method": obj.get("amortisationMethod")
+        })
+        return _obj

lusid/models/amortisation_rule_set.py

@@ -0,0 +1,141 @@
+# 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 BaseModel, Field, StrictStr, conlist, constr, validator
+from lusid.models.link import Link
+from lusid.models.resource_id import ResourceId
+from lusid.models.rules_interval import RulesInterval
+from lusid.models.version import Version
+
+class AmortisationRuleSet(BaseModel):
+    """
+    AmortisationRuleSet
+    """
+    href: Optional[StrictStr] = Field(None, description="The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.")
+    id: ResourceId = Field(...)
+    display_name: constr(strict=True, max_length=256, min_length=1) = Field(..., alias="displayName", description="A user-friendly name.")
+    description: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, description="A description of what this rule set is for.")
+    rules_interval: RulesInterval = Field(..., alias="rulesInterval")
+    version: Optional[Version] = None
+    links: Optional[conlist(Link)] = None
+    __properties = ["href", "id", "displayName", "description", "rulesInterval", "version", "links"]
+
+    @validator('display_name')
+    def display_name_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[^\\<>&\"]+$", value):
+            raise ValueError(r"must validate the regular expression /^[^\\<>&\"]+$/")
+        return value
+
+    @validator('description')
+    def description_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 __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) -> AmortisationRuleSet:
+        """Create an instance of AmortisationRuleSet 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 id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rules_interval
+        if self.rules_interval:
+            _dict['rulesInterval'] = self.rules_interval.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of version
+        if self.version:
+            _dict['version'] = self.version.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 href (nullable) is None
+        # and __fields_set__ contains the field
+        if self.href is None and "href" in self.__fields_set__:
+            _dict['href'] = None
+
+        # set to None if description (nullable) is None
+        # and __fields_set__ contains the field
+        if self.description is None and "description" in self.__fields_set__:
+            _dict['description'] = 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) -> AmortisationRuleSet:
+        """Create an instance of AmortisationRuleSet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return AmortisationRuleSet.parse_obj(obj)
+
+        _obj = AmortisationRuleSet.parse_obj({
+            "href": obj.get("href"),
+            "id": ResourceId.from_dict(obj.get("id")) if obj.get("id") is not None else None,
+            "display_name": obj.get("displayName"),
+            "description": obj.get("description"),
+            "rules_interval": RulesInterval.from_dict(obj.get("rulesInterval")) if obj.get("rulesInterval") is not None else None,
+            "version": Version.from_dict(obj.get("version")) if obj.get("version") 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