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

lusid/models/fx_forward_settlement_event.py

@@ -5,490 +5,148 @@
 
     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 FxForwardSettlementEvent(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, Optional, Union
+from pydantic.v1 import Field, StrictBool, StrictFloat, StrictInt, StrictStr, validator
+from lusid.models.instrument_event import InstrumentEvent
 
+class FxForwardSettlementEvent(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'.
+    Settlement for FX Forward, including NDF and deliverable.  # noqa: E501
     """
-    openapi_types = {
-        'maturity_date': 'datetime',
-        'dom_amount_per_unit': 'float',
-        'dom_ccy': 'str',
-        'fgn_amount_per_unit': 'float',
-        'fgn_ccy': 'str',
-        'is_ndf': 'bool',
-        'fixing_date': 'datetime',
-        'settlement_ccy': 'str',
-        'cash_flow_per_unit': 'float',
-        'domestic_to_foreign_rate': 'float',
-        'domestic_to_settlement_rate': 'float',
-        'instrument_event_type': 'str'
-    }
-
-    attribute_map = {
-        'maturity_date': 'maturityDate',
-        'dom_amount_per_unit': 'domAmountPerUnit',
-        'dom_ccy': 'domCcy',
-        'fgn_amount_per_unit': 'fgnAmountPerUnit',
-        'fgn_ccy': 'fgnCcy',
-        'is_ndf': 'isNdf',
-        'fixing_date': 'fixingDate',
-        'settlement_ccy': 'settlementCcy',
-        'cash_flow_per_unit': 'cashFlowPerUnit',
-        'domestic_to_foreign_rate': 'domesticToForeignRate',
-        'domestic_to_settlement_rate': 'domesticToSettlementRate',
-        'instrument_event_type': 'instrumentEventType'
-    }
-
-    required_map = {
-        'maturity_date': 'required',
-        'dom_amount_per_unit': 'required',
-        'dom_ccy': 'required',
-        'fgn_amount_per_unit': 'required',
-        'fgn_ccy': 'required',
-        'is_ndf': 'required',
-        'fixing_date': 'optional',
-        'settlement_ccy': 'optional',
-        'cash_flow_per_unit': 'optional',
-        'domestic_to_foreign_rate': 'optional',
-        'domestic_to_settlement_rate': 'optional',
-        'instrument_event_type': 'required'
-    }
-
-    def __init__(self, maturity_date=None, dom_amount_per_unit=None, dom_ccy=None, fgn_amount_per_unit=None, fgn_ccy=None, is_ndf=None, fixing_date=None, settlement_ccy=None, cash_flow_per_unit=None, domestic_to_foreign_rate=None, domestic_to_settlement_rate=None, instrument_event_type=None, local_vars_configuration=None):  # noqa: E501
-        """FxForwardSettlementEvent - a model defined in OpenAPI"
-        
-        :param maturity_date:  Maturity date of the forward (required)
-        :type maturity_date: datetime
-        :param dom_amount_per_unit:  Amount per unit in the DomCcy (domestic currency) (required)
-        :type dom_amount_per_unit: float
-        :param dom_ccy:  The domestic currency of the forward (required)
-        :type dom_ccy: str
-        :param fgn_amount_per_unit:  Amount per unit in the FgnCcy (foreign currency) (required)
-        :type fgn_amount_per_unit: float
-        :param fgn_ccy:  The foreign currency of the forward. (required)
-        :type fgn_ccy: str
-        :param is_ndf:  Is this settlement corresponding to a deliverable forward, or an NDF (required)
-        :type is_ndf: bool
-        :param fixing_date:  Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  Date of the FxRate fixings.
-        :type fixing_date: datetime
-        :param settlement_ccy:  Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  May be set to either DomCcy or FgnCcy, or a third currency.
-        :type settlement_ccy: str
-        :param cash_flow_per_unit:  Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  CashFlow per unit.  Paid in the SettlementCcy.
-        :type cash_flow_per_unit: float
-        :param domestic_to_foreign_rate:  Domestic currency to foreign currency FX rate.  Not required, only used to override quotes.
-        :type domestic_to_foreign_rate: float
-        :param domestic_to_settlement_rate:  Domestic currency to settlement currency FX rate  Not required, only used to override quotes.
-        :type domestic_to_settlement_rate: float
-        :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._maturity_date = None
-        self._dom_amount_per_unit = None
-        self._dom_ccy = None
-        self._fgn_amount_per_unit = None
-        self._fgn_ccy = None
-        self._is_ndf = None
-        self._fixing_date = None
-        self._settlement_ccy = None
-        self._cash_flow_per_unit = None
-        self._domestic_to_foreign_rate = None
-        self._domestic_to_settlement_rate = None
-        self._instrument_event_type = None
-        self.discriminator = None
-
-        self.maturity_date = maturity_date
-        self.dom_amount_per_unit = dom_amount_per_unit
-        self.dom_ccy = dom_ccy
-        self.fgn_amount_per_unit = fgn_amount_per_unit
-        self.fgn_ccy = fgn_ccy
-        self.is_ndf = is_ndf
-        self.fixing_date = fixing_date
-        self.settlement_ccy = settlement_ccy
-        self.cash_flow_per_unit = cash_flow_per_unit
-        self.domestic_to_foreign_rate = domestic_to_foreign_rate
-        self.domestic_to_settlement_rate = domestic_to_settlement_rate
-        self.instrument_event_type = instrument_event_type
-
-    @property
-    def maturity_date(self):
-        """Gets the maturity_date of this FxForwardSettlementEvent.  # noqa: E501
-
-        Maturity date of the forward  # noqa: E501
-
-        :return: The maturity_date of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._maturity_date
-
-    @maturity_date.setter
-    def maturity_date(self, maturity_date):
-        """Sets the maturity_date of this FxForwardSettlementEvent.
-
-        Maturity date of the forward  # noqa: E501
-
-        :param maturity_date: The maturity_date of this FxForwardSettlementEvent.  # noqa: E501
-        :type maturity_date: datetime
-        """
-        if self.local_vars_configuration.client_side_validation and maturity_date is None:  # noqa: E501
-            raise ValueError("Invalid value for `maturity_date`, must not be `None`")  # noqa: E501
-
-        self._maturity_date = maturity_date
-
-    @property
-    def dom_amount_per_unit(self):
-        """Gets the dom_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-
-        Amount per unit in the DomCcy (domestic currency)  # noqa: E501
-
-        :return: The dom_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._dom_amount_per_unit
-
-    @dom_amount_per_unit.setter
-    def dom_amount_per_unit(self, dom_amount_per_unit):
-        """Sets the dom_amount_per_unit of this FxForwardSettlementEvent.
-
-        Amount per unit in the DomCcy (domestic currency)  # noqa: E501
-
-        :param dom_amount_per_unit: The dom_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :type dom_amount_per_unit: float
-        """
-        if self.local_vars_configuration.client_side_validation and dom_amount_per_unit is None:  # noqa: E501
-            raise ValueError("Invalid value for `dom_amount_per_unit`, must not be `None`")  # noqa: E501
-
-        self._dom_amount_per_unit = dom_amount_per_unit
-
-    @property
-    def dom_ccy(self):
-        """Gets the dom_ccy of this FxForwardSettlementEvent.  # noqa: E501
-
-        The domestic currency of the forward  # noqa: E501
-
-        :return: The dom_ccy of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._dom_ccy
-
-    @dom_ccy.setter
-    def dom_ccy(self, dom_ccy):
-        """Sets the dom_ccy of this FxForwardSettlementEvent.
-
-        The domestic currency of the forward  # noqa: E501
-
-        :param dom_ccy: The dom_ccy of this FxForwardSettlementEvent.  # 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 fgn_amount_per_unit(self):
-        """Gets the fgn_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-
-        Amount per unit in the FgnCcy (foreign currency)  # noqa: E501
-
-        :return: The fgn_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._fgn_amount_per_unit
-
-    @fgn_amount_per_unit.setter
-    def fgn_amount_per_unit(self, fgn_amount_per_unit):
-        """Sets the fgn_amount_per_unit of this FxForwardSettlementEvent.
-
-        Amount per unit in the FgnCcy (foreign currency)  # noqa: E501
-
-        :param fgn_amount_per_unit: The fgn_amount_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :type fgn_amount_per_unit: float
-        """
-        if self.local_vars_configuration.client_side_validation and fgn_amount_per_unit is None:  # noqa: E501
-            raise ValueError("Invalid value for `fgn_amount_per_unit`, must not be `None`")  # noqa: E501
-
-        self._fgn_amount_per_unit = fgn_amount_per_unit
-
-    @property
-    def fgn_ccy(self):
-        """Gets the fgn_ccy of this FxForwardSettlementEvent.  # noqa: E501
-
-        The foreign currency of the forward.  # noqa: E501
-
-        :return: The fgn_ccy of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._fgn_ccy
-
-    @fgn_ccy.setter
-    def fgn_ccy(self, fgn_ccy):
-        """Sets the fgn_ccy of this FxForwardSettlementEvent.
-
-        The foreign currency of the forward.  # noqa: E501
-
-        :param fgn_ccy: The fgn_ccy of this FxForwardSettlementEvent.  # noqa: E501
-        :type fgn_ccy: str
-        """
-        if self.local_vars_configuration.client_side_validation and fgn_ccy is None:  # noqa: E501
-            raise ValueError("Invalid value for `fgn_ccy`, must not be `None`")  # noqa: E501
-
-        self._fgn_ccy = fgn_ccy
-
-    @property
-    def is_ndf(self):
-        """Gets the is_ndf of this FxForwardSettlementEvent.  # noqa: E501
-
-        Is this settlement corresponding to a deliverable forward, or an NDF  # noqa: E501
-
-        :return: The is_ndf of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: bool
-        """
-        return self._is_ndf
-
-    @is_ndf.setter
-    def is_ndf(self, is_ndf):
-        """Sets the is_ndf of this FxForwardSettlementEvent.
-
-        Is this settlement corresponding to a deliverable forward, or an NDF  # noqa: E501
-
-        :param is_ndf: The is_ndf of this FxForwardSettlementEvent.  # noqa: E501
-        :type is_ndf: bool
-        """
-        if self.local_vars_configuration.client_side_validation and is_ndf is None:  # noqa: E501
-            raise ValueError("Invalid value for `is_ndf`, must not be `None`")  # noqa: E501
-
-        self._is_ndf = is_ndf
-
-    @property
-    def fixing_date(self):
-        """Gets the fixing_date of this FxForwardSettlementEvent.  # noqa: E501
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  Date of the FxRate fixings.  # noqa: E501
-
-        :return: The fixing_date of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: datetime
-        """
-        return self._fixing_date
-
-    @fixing_date.setter
-    def fixing_date(self, fixing_date):
-        """Sets the fixing_date of this FxForwardSettlementEvent.
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  Date of the FxRate fixings.  # noqa: E501
-
-        :param fixing_date: The fixing_date of this FxForwardSettlementEvent.  # noqa: E501
-        :type fixing_date: datetime
-        """
-
-        self._fixing_date = fixing_date
-
-    @property
-    def settlement_ccy(self):
-        """Gets the settlement_ccy of this FxForwardSettlementEvent.  # noqa: E501
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  May be set to either DomCcy or FgnCcy, or a third currency.  # noqa: E501
-
-        :return: The settlement_ccy of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: str
-        """
-        return self._settlement_ccy
-
-    @settlement_ccy.setter
-    def settlement_ccy(self, settlement_ccy):
-        """Sets the settlement_ccy of this FxForwardSettlementEvent.
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  May be set to either DomCcy or FgnCcy, or a third currency.  # noqa: E501
-
-        :param settlement_ccy: The settlement_ccy of this FxForwardSettlementEvent.  # noqa: E501
-        :type settlement_ccy: str
-        """
-
-        self._settlement_ccy = settlement_ccy
-
-    @property
-    def cash_flow_per_unit(self):
-        """Gets the cash_flow_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  CashFlow per unit.  Paid in the SettlementCcy.  # noqa: E501
-
-        :return: The cash_flow_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._cash_flow_per_unit
-
-    @cash_flow_per_unit.setter
-    def cash_flow_per_unit(self, cash_flow_per_unit):
-        """Sets the cash_flow_per_unit of this FxForwardSettlementEvent.
-
-        Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  CashFlow per unit.  Paid in the SettlementCcy.  # noqa: E501
-
-        :param cash_flow_per_unit: The cash_flow_per_unit of this FxForwardSettlementEvent.  # noqa: E501
-        :type cash_flow_per_unit: float
-        """
-
-        self._cash_flow_per_unit = cash_flow_per_unit
-
-    @property
-    def domestic_to_foreign_rate(self):
-        """Gets the domestic_to_foreign_rate of this FxForwardSettlementEvent.  # noqa: E501
-
-        Domestic currency to foreign currency FX rate.  Not required, only used to override quotes.  # noqa: E501
-
-        :return: The domestic_to_foreign_rate of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._domestic_to_foreign_rate
-
-    @domestic_to_foreign_rate.setter
-    def domestic_to_foreign_rate(self, domestic_to_foreign_rate):
-        """Sets the domestic_to_foreign_rate of this FxForwardSettlementEvent.
-
-        Domestic currency to foreign currency FX rate.  Not required, only used to override quotes.  # noqa: E501
-
-        :param domestic_to_foreign_rate: The domestic_to_foreign_rate of this FxForwardSettlementEvent.  # noqa: E501
-        :type domestic_to_foreign_rate: float
-        """
-
-        self._domestic_to_foreign_rate = domestic_to_foreign_rate
-
-    @property
-    def domestic_to_settlement_rate(self):
-        """Gets the domestic_to_settlement_rate of this FxForwardSettlementEvent.  # noqa: E501
-
-        Domestic currency to settlement currency FX rate  Not required, only used to override quotes.  # noqa: E501
-
-        :return: The domestic_to_settlement_rate of this FxForwardSettlementEvent.  # noqa: E501
-        :rtype: float
-        """
-        return self._domestic_to_settlement_rate
-
-    @domestic_to_settlement_rate.setter
-    def domestic_to_settlement_rate(self, domestic_to_settlement_rate):
-        """Sets the domestic_to_settlement_rate of this FxForwardSettlementEvent.
-
-        Domestic currency to settlement currency FX rate  Not required, only used to override quotes.  # noqa: E501
-
-        :param domestic_to_settlement_rate: The domestic_to_settlement_rate of this FxForwardSettlementEvent.  # noqa: E501
-        :type domestic_to_settlement_rate: float
-        """
-
-        self._domestic_to_settlement_rate = domestic_to_settlement_rate
-
-    @property
-    def instrument_event_type(self):
-        """Gets the instrument_event_type of this FxForwardSettlementEvent.  # 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 FxForwardSettlementEvent.  # 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 FxForwardSettlementEvent.
-
-        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 FxForwardSettlementEvent.  # 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())
+    maturity_date: datetime = Field(..., alias="maturityDate", description="Maturity date of the forward")
+    dom_amount_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="domAmountPerUnit", description="Amount per unit in the DomCcy (domestic currency)")
+    dom_ccy: StrictStr = Field(..., alias="domCcy", description="The domestic currency of the forward")
+    fgn_amount_per_unit: Union[StrictFloat, StrictInt] = Field(..., alias="fgnAmountPerUnit", description="Amount per unit in the FgnCcy (foreign currency)")
+    fgn_ccy: StrictStr = Field(..., alias="fgnCcy", description="The foreign currency of the forward.")
+    is_ndf: StrictBool = Field(..., alias="isNdf", description="Is this settlement corresponding to a deliverable forward, or an NDF")
+    fixing_date: Optional[datetime] = Field(None, alias="fixingDate", description="Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  Date of the FxRate fixings.")
+    settlement_ccy: Optional[StrictStr] = Field(None, alias="settlementCcy", description="Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  May be set to either DomCcy or FgnCcy, or a third currency.")
+    cash_flow_per_unit: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="cashFlowPerUnit", description="Optional.  Required if the event is an NDF (i.e. if IsNdf = true).  CashFlow per unit.  Paid in the SettlementCcy.")
+    domestic_to_foreign_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="domesticToForeignRate", description="Domestic currency to foreign currency FX rate.  Not required, only used to override quotes.")
+    domestic_to_settlement_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="domesticToSettlementRate", description="Domestic currency to settlement currency FX rate  Not required, only used to override quotes.")
+    foreign_to_settlement_rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, alias="foreignToSettlementRate", description="Foreign currency to settlement currency FX rate  Not required, only used to override quotes.")
+    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", "maturityDate", "domAmountPerUnit", "domCcy", "fgnAmountPerUnit", "fgnCcy", "isNdf", "fixingDate", "settlementCcy", "cashFlowPerUnit", "domesticToForeignRate", "domesticToSettlementRate", "foreignToSettlementRate"]
+
+    @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, FxForwardSettlementEvent):
-            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, FxForwardSettlementEvent):
-            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) -> FxForwardSettlementEvent:
+        """Create an instance of FxForwardSettlementEvent 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={
+                            "foreign_to_settlement_rate",
+                            "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
+
+        # set to None if fixing_date (nullable) is None
+        # and __fields_set__ contains the field
+        if self.fixing_date is None and "fixing_date" in self.__fields_set__:
+            _dict['fixingDate'] = None
+
+        # set to None if settlement_ccy (nullable) is None
+        # and __fields_set__ contains the field
+        if self.settlement_ccy is None and "settlement_ccy" in self.__fields_set__:
+            _dict['settlementCcy'] = None
+
+        # set to None if cash_flow_per_unit (nullable) is None
+        # and __fields_set__ contains the field
+        if self.cash_flow_per_unit is None and "cash_flow_per_unit" in self.__fields_set__:
+            _dict['cashFlowPerUnit'] = None
+
+        # set to None if domestic_to_foreign_rate (nullable) is None
+        # and __fields_set__ contains the field
+        if self.domestic_to_foreign_rate is None and "domestic_to_foreign_rate" in self.__fields_set__:
+            _dict['domesticToForeignRate'] = None
+
+        # set to None if domestic_to_settlement_rate (nullable) is None
+        # and __fields_set__ contains the field
+        if self.domestic_to_settlement_rate is None and "domestic_to_settlement_rate" in self.__fields_set__:
+            _dict['domesticToSettlementRate'] = None
+
+        # set to None if foreign_to_settlement_rate (nullable) is None
+        # and __fields_set__ contains the field
+        if self.foreign_to_settlement_rate is None and "foreign_to_settlement_rate" in self.__fields_set__:
+            _dict['foreignToSettlementRate'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> FxForwardSettlementEvent:
+        """Create an instance of FxForwardSettlementEvent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return FxForwardSettlementEvent.parse_obj(obj)
+
+        _obj = FxForwardSettlementEvent.parse_obj({
+            "instrument_event_type": obj.get("instrumentEventType"),
+            "maturity_date": obj.get("maturityDate"),
+            "dom_amount_per_unit": obj.get("domAmountPerUnit"),
+            "dom_ccy": obj.get("domCcy"),
+            "fgn_amount_per_unit": obj.get("fgnAmountPerUnit"),
+            "fgn_ccy": obj.get("fgnCcy"),
+            "is_ndf": obj.get("isNdf"),
+            "fixing_date": obj.get("fixingDate"),
+            "settlement_ccy": obj.get("settlementCcy"),
+            "cash_flow_per_unit": obj.get("cashFlowPerUnit"),
+            "domestic_to_foreign_rate": obj.get("domesticToForeignRate"),
+            "domestic_to_settlement_rate": obj.get("domesticToSettlementRate"),
+            "foreign_to_settlement_rate": obj.get("foreignToSettlementRate")
+        })
+        # 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