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

lusid/models/portfolio_holding.py

@@ -5,688 +5,181 @@
 
     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 PortfolioHolding(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, Optional, Union
+from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr, constr
+from lusid.models.currency_and_amount import CurrencyAndAmount
+from lusid.models.model_property import ModelProperty
+from lusid.models.perpetual_property import PerpetualProperty
+from lusid.models.transaction import Transaction
 
+class PortfolioHolding(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'.
+    A list of holdings.  # noqa: E501
     """
-    openapi_types = {
-        'instrument_scope': 'str',
-        'instrument_uid': 'str',
-        'sub_holding_keys': 'dict(str, PerpetualProperty)',
-        'properties': 'dict(str, ModelProperty)',
-        'holding_type': 'str',
-        'units': 'float',
-        'settled_units': 'float',
-        'cost': 'CurrencyAndAmount',
-        'cost_portfolio_ccy': 'CurrencyAndAmount',
-        'transaction': 'Transaction',
-        'currency': 'str',
-        'holding_type_name': 'str',
-        'holding_id': 'int',
-        'notional_cost': 'CurrencyAndAmount',
-        'amortised_cost': 'CurrencyAndAmount',
-        'amortised_cost_portfolio_ccy': 'CurrencyAndAmount',
-        'variation_margin': 'CurrencyAndAmount',
-        'variation_margin_portfolio_ccy': 'CurrencyAndAmount',
-        'settlement_schedule': 'list[SettlementSchedule]'
-    }
-
-    attribute_map = {
-        'instrument_scope': 'instrumentScope',
-        'instrument_uid': 'instrumentUid',
-        'sub_holding_keys': 'subHoldingKeys',
-        'properties': 'properties',
-        'holding_type': 'holdingType',
-        'units': 'units',
-        'settled_units': 'settledUnits',
-        'cost': 'cost',
-        'cost_portfolio_ccy': 'costPortfolioCcy',
-        'transaction': 'transaction',
-        'currency': 'currency',
-        'holding_type_name': 'holdingTypeName',
-        'holding_id': 'holdingId',
-        'notional_cost': 'notionalCost',
-        'amortised_cost': 'amortisedCost',
-        'amortised_cost_portfolio_ccy': 'amortisedCostPortfolioCcy',
-        'variation_margin': 'variationMargin',
-        'variation_margin_portfolio_ccy': 'variationMarginPortfolioCcy',
-        'settlement_schedule': 'settlementSchedule'
-    }
-
-    required_map = {
-        'instrument_scope': 'optional',
-        'instrument_uid': 'required',
-        'sub_holding_keys': 'optional',
-        'properties': 'optional',
-        'holding_type': 'required',
-        'units': 'required',
-        'settled_units': 'required',
-        'cost': 'required',
-        'cost_portfolio_ccy': 'required',
-        'transaction': 'optional',
-        'currency': 'optional',
-        'holding_type_name': 'optional',
-        'holding_id': 'optional',
-        'notional_cost': 'optional',
-        'amortised_cost': 'optional',
-        'amortised_cost_portfolio_ccy': 'optional',
-        'variation_margin': 'optional',
-        'variation_margin_portfolio_ccy': 'optional',
-        'settlement_schedule': 'optional'
-    }
-
-    def __init__(self, instrument_scope=None, instrument_uid=None, sub_holding_keys=None, properties=None, holding_type=None, units=None, settled_units=None, cost=None, cost_portfolio_ccy=None, transaction=None, currency=None, holding_type_name=None, holding_id=None, notional_cost=None, amortised_cost=None, amortised_cost_portfolio_ccy=None, variation_margin=None, variation_margin_portfolio_ccy=None, settlement_schedule=None, local_vars_configuration=None):  # noqa: E501
-        """PortfolioHolding - a model defined in OpenAPI"
-        
-        :param instrument_scope:  The scope in which the holding's instrument is in.
-        :type instrument_scope: str
-        :param instrument_uid:  The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required)
-        :type instrument_uid: str
-        :param sub_holding_keys:  The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.
-        :type sub_holding_keys: dict[str, lusid.PerpetualProperty]
-        :param properties:  The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain.
-        :type properties: dict[str, lusid.ModelProperty]
-        :param holding_type:  The code for the type of the holding e.g. P, B, C, R, F etc. (required)
-        :type holding_type: str
-        :param units:  The total number of units of the holding. (required)
-        :type units: float
-        :param settled_units:  The total number of settled units of the holding. (required)
-        :type settled_units: float
-        :param cost:  (required)
-        :type cost: lusid.CurrencyAndAmount
-        :param cost_portfolio_ccy:  (required)
-        :type cost_portfolio_ccy: lusid.CurrencyAndAmount
-        :param transaction: 
-        :type transaction: lusid.Transaction
-        :param currency:  The holding currency.
-        :type currency: str
-        :param holding_type_name:  The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc.
-        :type holding_type_name: str
-        :param holding_id:  A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.
-        :type holding_id: int
-        :param notional_cost: 
-        :type notional_cost: lusid.CurrencyAndAmount
-        :param amortised_cost: 
-        :type amortised_cost: lusid.CurrencyAndAmount
-        :param amortised_cost_portfolio_ccy: 
-        :type amortised_cost_portfolio_ccy: lusid.CurrencyAndAmount
-        :param variation_margin: 
-        :type variation_margin: lusid.CurrencyAndAmount
-        :param variation_margin_portfolio_ccy: 
-        :type variation_margin_portfolio_ccy: lusid.CurrencyAndAmount
-        :param settlement_schedule:  Where no. of days ahead has been specified, future dated settlements will be captured here.
-        :type settlement_schedule: list[lusid.SettlementSchedule]
-
-        """  # noqa: E501
-        if local_vars_configuration is None:
-            local_vars_configuration = Configuration.get_default_copy()
-        self.local_vars_configuration = local_vars_configuration
-
-        self._instrument_scope = None
-        self._instrument_uid = None
-        self._sub_holding_keys = None
-        self._properties = None
-        self._holding_type = None
-        self._units = None
-        self._settled_units = None
-        self._cost = None
-        self._cost_portfolio_ccy = None
-        self._transaction = None
-        self._currency = None
-        self._holding_type_name = None
-        self._holding_id = None
-        self._notional_cost = None
-        self._amortised_cost = None
-        self._amortised_cost_portfolio_ccy = None
-        self._variation_margin = None
-        self._variation_margin_portfolio_ccy = None
-        self._settlement_schedule = None
-        self.discriminator = None
-
-        self.instrument_scope = instrument_scope
-        self.instrument_uid = instrument_uid
-        self.sub_holding_keys = sub_holding_keys
-        self.properties = properties
-        self.holding_type = holding_type
-        self.units = units
-        self.settled_units = settled_units
-        self.cost = cost
-        self.cost_portfolio_ccy = cost_portfolio_ccy
-        if transaction is not None:
-            self.transaction = transaction
-        self.currency = currency
-        self.holding_type_name = holding_type_name
-        self.holding_id = holding_id
-        if notional_cost is not None:
-            self.notional_cost = notional_cost
-        if amortised_cost is not None:
-            self.amortised_cost = amortised_cost
-        if amortised_cost_portfolio_ccy is not None:
-            self.amortised_cost_portfolio_ccy = amortised_cost_portfolio_ccy
-        if variation_margin is not None:
-            self.variation_margin = variation_margin
-        if variation_margin_portfolio_ccy is not None:
-            self.variation_margin_portfolio_ccy = variation_margin_portfolio_ccy
-        self.settlement_schedule = settlement_schedule
-
-    @property
-    def instrument_scope(self):
-        """Gets the instrument_scope of this PortfolioHolding.  # noqa: E501
-
-        The scope in which the holding's instrument is in.  # noqa: E501
-
-        :return: The instrument_scope of this PortfolioHolding.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_scope
-
-    @instrument_scope.setter
-    def instrument_scope(self, instrument_scope):
-        """Sets the instrument_scope of this PortfolioHolding.
-
-        The scope in which the holding's instrument is in.  # noqa: E501
-
-        :param instrument_scope: The instrument_scope of this PortfolioHolding.  # noqa: E501
-        :type instrument_scope: str
-        """
-
-        self._instrument_scope = instrument_scope
-
-    @property
-    def instrument_uid(self):
-        """Gets the instrument_uid of this PortfolioHolding.  # noqa: E501
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :return: The instrument_uid of this PortfolioHolding.  # noqa: E501
-        :rtype: str
-        """
-        return self._instrument_uid
-
-    @instrument_uid.setter
-    def instrument_uid(self, instrument_uid):
-        """Sets the instrument_uid of this PortfolioHolding.
-
-        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
-
-        :param instrument_uid: The instrument_uid of this PortfolioHolding.  # noqa: E501
-        :type instrument_uid: str
-        """
-        if self.local_vars_configuration.client_side_validation and instrument_uid is None:  # noqa: E501
-            raise ValueError("Invalid value for `instrument_uid`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                instrument_uid is not None and len(instrument_uid) < 1):
-            raise ValueError("Invalid value for `instrument_uid`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._instrument_uid = instrument_uid
-
-    @property
-    def sub_holding_keys(self):
-        """Gets the sub_holding_keys of this PortfolioHolding.  # noqa: E501
-
-        The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.  # noqa: E501
-
-        :return: The sub_holding_keys of this PortfolioHolding.  # noqa: E501
-        :rtype: dict[str, lusid.PerpetualProperty]
-        """
-        return self._sub_holding_keys
-
-    @sub_holding_keys.setter
-    def sub_holding_keys(self, sub_holding_keys):
-        """Sets the sub_holding_keys of this PortfolioHolding.
-
-        The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.  # noqa: E501
-
-        :param sub_holding_keys: The sub_holding_keys of this PortfolioHolding.  # noqa: E501
-        :type sub_holding_keys: dict[str, lusid.PerpetualProperty]
-        """
-
-        self._sub_holding_keys = sub_holding_keys
-
-    @property
-    def properties(self):
-        """Gets the properties of this PortfolioHolding.  # noqa: E501
-
-        The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain.  # noqa: E501
-
-        :return: The properties of this PortfolioHolding.  # noqa: E501
-        :rtype: dict[str, lusid.ModelProperty]
-        """
-        return self._properties
-
-    @properties.setter
-    def properties(self, properties):
-        """Sets the properties of this PortfolioHolding.
-
-        The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain.  # noqa: E501
-
-        :param properties: The properties of this PortfolioHolding.  # noqa: E501
-        :type properties: dict[str, lusid.ModelProperty]
-        """
-
-        self._properties = properties
-
-    @property
-    def holding_type(self):
-        """Gets the holding_type of this PortfolioHolding.  # noqa: E501
-
-        The code for the type of the holding e.g. P, B, C, R, F etc.  # noqa: E501
-
-        :return: The holding_type of this PortfolioHolding.  # noqa: E501
-        :rtype: str
-        """
-        return self._holding_type
-
-    @holding_type.setter
-    def holding_type(self, holding_type):
-        """Sets the holding_type of this PortfolioHolding.
-
-        The code for the type of the holding e.g. P, B, C, R, F etc.  # noqa: E501
-
-        :param holding_type: The holding_type of this PortfolioHolding.  # noqa: E501
-        :type holding_type: str
-        """
-        if self.local_vars_configuration.client_side_validation and holding_type is None:  # noqa: E501
-            raise ValueError("Invalid value for `holding_type`, must not be `None`")  # noqa: E501
-        if (self.local_vars_configuration.client_side_validation and
-                holding_type is not None and len(holding_type) < 1):
-            raise ValueError("Invalid value for `holding_type`, length must be greater than or equal to `1`")  # noqa: E501
-
-        self._holding_type = holding_type
-
-    @property
-    def units(self):
-        """Gets the units of this PortfolioHolding.  # noqa: E501
-
-        The total number of units of the holding.  # noqa: E501
-
-        :return: The units of this PortfolioHolding.  # noqa: E501
-        :rtype: float
-        """
-        return self._units
-
-    @units.setter
-    def units(self, units):
-        """Sets the units of this PortfolioHolding.
-
-        The total number of units of the holding.  # noqa: E501
-
-        :param units: The units of this PortfolioHolding.  # noqa: E501
-        :type units: float
-        """
-        if self.local_vars_configuration.client_side_validation and units is None:  # noqa: E501
-            raise ValueError("Invalid value for `units`, must not be `None`")  # noqa: E501
-
-        self._units = units
-
-    @property
-    def settled_units(self):
-        """Gets the settled_units of this PortfolioHolding.  # noqa: E501
-
-        The total number of settled units of the holding.  # noqa: E501
-
-        :return: The settled_units of this PortfolioHolding.  # noqa: E501
-        :rtype: float
-        """
-        return self._settled_units
-
-    @settled_units.setter
-    def settled_units(self, settled_units):
-        """Sets the settled_units of this PortfolioHolding.
-
-        The total number of settled units of the holding.  # noqa: E501
-
-        :param settled_units: The settled_units of this PortfolioHolding.  # noqa: E501
-        :type settled_units: float
-        """
-        if self.local_vars_configuration.client_side_validation and settled_units is None:  # noqa: E501
-            raise ValueError("Invalid value for `settled_units`, must not be `None`")  # noqa: E501
-
-        self._settled_units = settled_units
-
-    @property
-    def cost(self):
-        """Gets the cost of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The cost of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._cost
-
-    @cost.setter
-    def cost(self, cost):
-        """Sets the cost of this PortfolioHolding.
-
-
-        :param cost: The cost of this PortfolioHolding.  # noqa: E501
-        :type cost: lusid.CurrencyAndAmount
-        """
-        if self.local_vars_configuration.client_side_validation and cost is None:  # noqa: E501
-            raise ValueError("Invalid value for `cost`, must not be `None`")  # noqa: E501
-
-        self._cost = cost
-
-    @property
-    def cost_portfolio_ccy(self):
-        """Gets the cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._cost_portfolio_ccy
-
-    @cost_portfolio_ccy.setter
-    def cost_portfolio_ccy(self, cost_portfolio_ccy):
-        """Sets the cost_portfolio_ccy of this PortfolioHolding.
-
-
-        :param cost_portfolio_ccy: The cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :type cost_portfolio_ccy: lusid.CurrencyAndAmount
-        """
-        if self.local_vars_configuration.client_side_validation and cost_portfolio_ccy is None:  # noqa: E501
-            raise ValueError("Invalid value for `cost_portfolio_ccy`, must not be `None`")  # noqa: E501
-
-        self._cost_portfolio_ccy = cost_portfolio_ccy
-
-    @property
-    def transaction(self):
-        """Gets the transaction of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The transaction of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.Transaction
-        """
-        return self._transaction
-
-    @transaction.setter
-    def transaction(self, transaction):
-        """Sets the transaction of this PortfolioHolding.
-
-
-        :param transaction: The transaction of this PortfolioHolding.  # noqa: E501
-        :type transaction: lusid.Transaction
-        """
-
-        self._transaction = transaction
-
-    @property
-    def currency(self):
-        """Gets the currency of this PortfolioHolding.  # noqa: E501
-
-        The holding currency.  # noqa: E501
-
-        :return: The currency of this PortfolioHolding.  # noqa: E501
-        :rtype: str
-        """
-        return self._currency
-
-    @currency.setter
-    def currency(self, currency):
-        """Sets the currency of this PortfolioHolding.
-
-        The holding currency.  # noqa: E501
-
-        :param currency: The currency of this PortfolioHolding.  # noqa: E501
-        :type currency: str
-        """
-
-        self._currency = currency
-
-    @property
-    def holding_type_name(self):
-        """Gets the holding_type_name of this PortfolioHolding.  # noqa: E501
-
-        The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc.  # noqa: E501
-
-        :return: The holding_type_name of this PortfolioHolding.  # noqa: E501
-        :rtype: str
-        """
-        return self._holding_type_name
-
-    @holding_type_name.setter
-    def holding_type_name(self, holding_type_name):
-        """Sets the holding_type_name of this PortfolioHolding.
-
-        The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc.  # noqa: E501
-
-        :param holding_type_name: The holding_type_name of this PortfolioHolding.  # noqa: E501
-        :type holding_type_name: str
-        """
-
-        self._holding_type_name = holding_type_name
-
-    @property
-    def holding_id(self):
-        """Gets the holding_id of this PortfolioHolding.  # noqa: E501
-
-        A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.  # noqa: E501
-
-        :return: The holding_id of this PortfolioHolding.  # noqa: E501
-        :rtype: int
-        """
-        return self._holding_id
-
-    @holding_id.setter
-    def holding_id(self, holding_id):
-        """Sets the holding_id of this PortfolioHolding.
-
-        A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.  # noqa: E501
-
-        :param holding_id: The holding_id of this PortfolioHolding.  # noqa: E501
-        :type holding_id: int
-        """
-
-        self._holding_id = holding_id
-
-    @property
-    def notional_cost(self):
-        """Gets the notional_cost of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The notional_cost of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._notional_cost
-
-    @notional_cost.setter
-    def notional_cost(self, notional_cost):
-        """Sets the notional_cost of this PortfolioHolding.
-
-
-        :param notional_cost: The notional_cost of this PortfolioHolding.  # noqa: E501
-        :type notional_cost: lusid.CurrencyAndAmount
-        """
-
-        self._notional_cost = notional_cost
-
-    @property
-    def amortised_cost(self):
-        """Gets the amortised_cost of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The amortised_cost of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._amortised_cost
-
-    @amortised_cost.setter
-    def amortised_cost(self, amortised_cost):
-        """Sets the amortised_cost of this PortfolioHolding.
-
-
-        :param amortised_cost: The amortised_cost of this PortfolioHolding.  # noqa: E501
-        :type amortised_cost: lusid.CurrencyAndAmount
-        """
-
-        self._amortised_cost = amortised_cost
-
-    @property
-    def amortised_cost_portfolio_ccy(self):
-        """Gets the amortised_cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The amortised_cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._amortised_cost_portfolio_ccy
-
-    @amortised_cost_portfolio_ccy.setter
-    def amortised_cost_portfolio_ccy(self, amortised_cost_portfolio_ccy):
-        """Sets the amortised_cost_portfolio_ccy of this PortfolioHolding.
-
-
-        :param amortised_cost_portfolio_ccy: The amortised_cost_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :type amortised_cost_portfolio_ccy: lusid.CurrencyAndAmount
-        """
-
-        self._amortised_cost_portfolio_ccy = amortised_cost_portfolio_ccy
-
-    @property
-    def variation_margin(self):
-        """Gets the variation_margin of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The variation_margin of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._variation_margin
-
-    @variation_margin.setter
-    def variation_margin(self, variation_margin):
-        """Sets the variation_margin of this PortfolioHolding.
-
-
-        :param variation_margin: The variation_margin of this PortfolioHolding.  # noqa: E501
-        :type variation_margin: lusid.CurrencyAndAmount
-        """
-
-        self._variation_margin = variation_margin
-
-    @property
-    def variation_margin_portfolio_ccy(self):
-        """Gets the variation_margin_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-
-
-        :return: The variation_margin_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :rtype: lusid.CurrencyAndAmount
-        """
-        return self._variation_margin_portfolio_ccy
-
-    @variation_margin_portfolio_ccy.setter
-    def variation_margin_portfolio_ccy(self, variation_margin_portfolio_ccy):
-        """Sets the variation_margin_portfolio_ccy of this PortfolioHolding.
-
-
-        :param variation_margin_portfolio_ccy: The variation_margin_portfolio_ccy of this PortfolioHolding.  # noqa: E501
-        :type variation_margin_portfolio_ccy: lusid.CurrencyAndAmount
-        """
-
-        self._variation_margin_portfolio_ccy = variation_margin_portfolio_ccy
-
-    @property
-    def settlement_schedule(self):
-        """Gets the settlement_schedule of this PortfolioHolding.  # noqa: E501
-
-        Where no. of days ahead has been specified, future dated settlements will be captured here.  # noqa: E501
-
-        :return: The settlement_schedule of this PortfolioHolding.  # noqa: E501
-        :rtype: list[lusid.SettlementSchedule]
-        """
-        return self._settlement_schedule
-
-    @settlement_schedule.setter
-    def settlement_schedule(self, settlement_schedule):
-        """Sets the settlement_schedule of this PortfolioHolding.
-
-        Where no. of days ahead has been specified, future dated settlements will be captured here.  # noqa: E501
-
-        :param settlement_schedule: The settlement_schedule of this PortfolioHolding.  # noqa: E501
-        :type settlement_schedule: list[lusid.SettlementSchedule]
-        """
-
-        self._settlement_schedule = settlement_schedule
-
-    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, PortfolioHolding):
-            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, PortfolioHolding):
-            return True
-
-        return self.to_dict() != other.to_dict()
+    instrument_scope: Optional[StrictStr] = Field(None, alias="instrumentScope", description="The scope in which the holding's instrument is in.")
+    instrument_uid: constr(strict=True, min_length=1) = Field(..., alias="instrumentUid", description="The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.")
+    sub_holding_keys: Optional[Dict[str, PerpetualProperty]] = Field(None, alias="subHoldingKeys", description="The sub-holding properties which identify the holding. Each property will be from the 'Transaction' domain. These are configured on a transaction portfolio.")
+    properties: Optional[Dict[str, ModelProperty]] = Field(None, description="The properties which have been requested to be decorated onto the holding. These will be from the 'Instrument' or 'Holding' domain.")
+    holding_type: constr(strict=True, min_length=1) = Field(..., alias="holdingType", description="The code for the type of the holding e.g. P, B, C, R, F etc.")
+    units: Union[StrictFloat, StrictInt] = Field(..., description="The total number of units of the holding.")
+    settled_units: Union[StrictFloat, StrictInt] = Field(..., alias="settledUnits", description="The total number of settled units of the holding.")
+    cost: CurrencyAndAmount = Field(...)
+    cost_portfolio_ccy: CurrencyAndAmount = Field(..., alias="costPortfolioCcy")
+    transaction: Optional[Transaction] = None
+    currency: Optional[StrictStr] = Field(None, description="The holding currency.")
+    holding_type_name: Optional[StrictStr] = Field(None, alias="holdingTypeName", description="The decoded type of the holding e.g. Position, Balance, CashCommitment, Receivable, ForwardFX etc.")
+    holding_id: Optional[StrictInt] = Field(None, alias="holdingId", description="A single identifier for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.")
+    notional_cost: Optional[CurrencyAndAmount] = Field(None, alias="notionalCost")
+    amortised_cost: Optional[CurrencyAndAmount] = Field(None, alias="amortisedCost")
+    amortised_cost_portfolio_ccy: Optional[CurrencyAndAmount] = Field(None, alias="amortisedCostPortfolioCcy")
+    variation_margin: Optional[CurrencyAndAmount] = Field(None, alias="variationMargin")
+    variation_margin_portfolio_ccy: Optional[CurrencyAndAmount] = Field(None, alias="variationMarginPortfolioCcy")
+    __properties = ["instrumentScope", "instrumentUid", "subHoldingKeys", "properties", "holdingType", "units", "settledUnits", "cost", "costPortfolioCcy", "transaction", "currency", "holdingTypeName", "holdingId", "notionalCost", "amortisedCost", "amortisedCostPortfolioCcy", "variationMargin", "variationMarginPortfolioCcy"]
+
+    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) -> PortfolioHolding:
+        """Create an instance of PortfolioHolding 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 sub_holding_keys (dict)
+        _field_dict = {}
+        if self.sub_holding_keys:
+            for _key in self.sub_holding_keys:
+                if self.sub_holding_keys[_key]:
+                    _field_dict[_key] = self.sub_holding_keys[_key].to_dict()
+            _dict['subHoldingKeys'] = _field_dict
+        # 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 cost
+        if self.cost:
+            _dict['cost'] = self.cost.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of cost_portfolio_ccy
+        if self.cost_portfolio_ccy:
+            _dict['costPortfolioCcy'] = self.cost_portfolio_ccy.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of transaction
+        if self.transaction:
+            _dict['transaction'] = self.transaction.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of notional_cost
+        if self.notional_cost:
+            _dict['notionalCost'] = self.notional_cost.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of amortised_cost
+        if self.amortised_cost:
+            _dict['amortisedCost'] = self.amortised_cost.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of amortised_cost_portfolio_ccy
+        if self.amortised_cost_portfolio_ccy:
+            _dict['amortisedCostPortfolioCcy'] = self.amortised_cost_portfolio_ccy.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of variation_margin
+        if self.variation_margin:
+            _dict['variationMargin'] = self.variation_margin.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of variation_margin_portfolio_ccy
+        if self.variation_margin_portfolio_ccy:
+            _dict['variationMarginPortfolioCcy'] = self.variation_margin_portfolio_ccy.to_dict()
+        # set to None if instrument_scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.instrument_scope is None and "instrument_scope" in self.__fields_set__:
+            _dict['instrumentScope'] = None
+
+        # set to None if sub_holding_keys (nullable) is None
+        # and __fields_set__ contains the field
+        if self.sub_holding_keys is None and "sub_holding_keys" in self.__fields_set__:
+            _dict['subHoldingKeys'] = None
+
+        # 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 currency (nullable) is None
+        # and __fields_set__ contains the field
+        if self.currency is None and "currency" in self.__fields_set__:
+            _dict['currency'] = None
+
+        # set to None if holding_type_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.holding_type_name is None and "holding_type_name" in self.__fields_set__:
+            _dict['holdingTypeName'] = None
+
+        # set to None if holding_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.holding_id is None and "holding_id" in self.__fields_set__:
+            _dict['holdingId'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> PortfolioHolding:
+        """Create an instance of PortfolioHolding from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return PortfolioHolding.parse_obj(obj)
+
+        _obj = PortfolioHolding.parse_obj({
+            "instrument_scope": obj.get("instrumentScope"),
+            "instrument_uid": obj.get("instrumentUid"),
+            "sub_holding_keys": dict(
+                (_k, PerpetualProperty.from_dict(_v))
+                for _k, _v in obj.get("subHoldingKeys").items()
+            )
+            if obj.get("subHoldingKeys") is not None
+            else None,
+            "properties": dict(
+                (_k, ModelProperty.from_dict(_v))
+                for _k, _v in obj.get("properties").items()
+            )
+            if obj.get("properties") is not None
+            else None,
+            "holding_type": obj.get("holdingType"),
+            "units": obj.get("units"),
+            "settled_units": obj.get("settledUnits"),
+            "cost": CurrencyAndAmount.from_dict(obj.get("cost")) if obj.get("cost") is not None else None,
+            "cost_portfolio_ccy": CurrencyAndAmount.from_dict(obj.get("costPortfolioCcy")) if obj.get("costPortfolioCcy") is not None else None,
+            "transaction": Transaction.from_dict(obj.get("transaction")) if obj.get("transaction") is not None else None,
+            "currency": obj.get("currency"),
+            "holding_type_name": obj.get("holdingTypeName"),
+            "holding_id": obj.get("holdingId"),
+            "notional_cost": CurrencyAndAmount.from_dict(obj.get("notionalCost")) if obj.get("notionalCost") is not None else None,
+            "amortised_cost": CurrencyAndAmount.from_dict(obj.get("amortisedCost")) if obj.get("amortisedCost") is not None else None,
+            "amortised_cost_portfolio_ccy": CurrencyAndAmount.from_dict(obj.get("amortisedCostPortfolioCcy")) if obj.get("amortisedCostPortfolioCcy") is not None else None,
+            "variation_margin": CurrencyAndAmount.from_dict(obj.get("variationMargin")) if obj.get("variationMargin") is not None else None,
+            "variation_margin_portfolio_ccy": CurrencyAndAmount.from_dict(obj.get("variationMarginPortfolioCcy")) if obj.get("variationMarginPortfolioCcy") is not None else None
+        })
+        return _obj