lusid-sdk 1.1.158__py3-none-any.whl → 1.1.162__py3-none-any.whl

lusid/models/instrument_cash_flow.py

@@ -0,0 +1,405 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    The version of the OpenAPI document: 1.1.162
+    Contact: info@finbourne.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+try:
+    from inspect import getfullargspec
+except ImportError:
+    from inspect import getargspec as getfullargspec
+import pprint
+import re  # noqa: F401
+import six
+
+from lusid.configuration import Configuration
+
+
+class InstrumentCashFlow(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    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'.
+    """
+    openapi_types = {
+        'payment_date': 'datetime',
+        'amount': 'float',
+        'currency': 'str',
+        'source_portfolio_id': 'ResourceId',
+        'source_transaction_id': 'str',
+        'source_instrument_scope': 'str',
+        'source_instrument_id': 'str',
+        'diagnostics': 'dict(str, str)',
+        'links': 'list[Link]'
+    }
+
+    attribute_map = {
+        'payment_date': 'paymentDate',
+        'amount': 'amount',
+        'currency': 'currency',
+        'source_portfolio_id': 'sourcePortfolioId',
+        'source_transaction_id': 'sourceTransactionId',
+        'source_instrument_scope': 'sourceInstrumentScope',
+        'source_instrument_id': 'sourceInstrumentId',
+        'diagnostics': 'diagnostics',
+        'links': 'links'
+    }
+
+    required_map = {
+        'payment_date': 'required',
+        'amount': 'optional',
+        'currency': 'required',
+        'source_portfolio_id': 'required',
+        'source_transaction_id': 'required',
+        'source_instrument_scope': 'required',
+        'source_instrument_id': 'required',
+        'diagnostics': 'required',
+        'links': 'optional'
+    }
+
+    def __init__(self, payment_date=None, amount=None, currency=None, source_portfolio_id=None, source_transaction_id=None, source_instrument_scope=None, source_instrument_id=None, diagnostics=None, links=None, local_vars_configuration=None):  # noqa: E501
+        """InstrumentCashFlow - a model defined in OpenAPI"
+        
+        :param payment_date:  The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.) (required)
+        :type payment_date: datetime
+        :param amount:  The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.
+        :type amount: float
+        :param currency:  The payment currency of the cash flow. (required)
+        :type currency: str
+        :param source_portfolio_id:  (required)
+        :type source_portfolio_id: lusid.ResourceId
+        :param source_transaction_id:  The identifier for the parent transaction on the instrument that will pay/receive this cash flow. (required)
+        :type source_transaction_id: str
+        :param source_instrument_scope:  The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required)
+        :type source_instrument_scope: str
+        :param source_instrument_id:  The unique Lusid Instrument Id (LUID) of the instrument that the holding is in. (required)
+        :type source_instrument_id: str
+        :param diagnostics:  Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data. (required)
+        :type diagnostics: dict(str, str)
+        :param links:  Collection of links.
+        :type links: list[lusid.Link]
+
+        """  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration.get_default_copy()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._payment_date = None
+        self._amount = None
+        self._currency = None
+        self._source_portfolio_id = None
+        self._source_transaction_id = None
+        self._source_instrument_scope = None
+        self._source_instrument_id = None
+        self._diagnostics = None
+        self._links = None
+        self.discriminator = None
+
+        self.payment_date = payment_date
+        self.amount = amount
+        self.currency = currency
+        self.source_portfolio_id = source_portfolio_id
+        self.source_transaction_id = source_transaction_id
+        self.source_instrument_scope = source_instrument_scope
+        self.source_instrument_id = source_instrument_id
+        self.diagnostics = diagnostics
+        self.links = links
+
+    @property
+    def payment_date(self):
+        """Gets the payment_date of this InstrumentCashFlow.  # noqa: E501
+
+        The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)  # noqa: E501
+
+        :return: The payment_date of this InstrumentCashFlow.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._payment_date
+
+    @payment_date.setter
+    def payment_date(self, payment_date):
+        """Sets the payment_date of this InstrumentCashFlow.
+
+        The date at which the given cash flow is due to be paid (SettlementDate is used somewhat interchangeably with PaymentDate.)  # noqa: E501
+
+        :param payment_date: The payment_date of this InstrumentCashFlow.  # 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 amount(self):
+        """Gets the amount of this InstrumentCashFlow.  # noqa: E501
+
+        The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.  # noqa: E501
+
+        :return: The amount of this InstrumentCashFlow.  # noqa: E501
+        :rtype: float
+        """
+        return self._amount
+
+    @amount.setter
+    def amount(self, amount):
+        """Sets the amount of this InstrumentCashFlow.
+
+        The quantity (amount) that will be paid. Note that this can be empty if the payment is in the future and a model is used that cannot estimate it.  # noqa: E501
+
+        :param amount: The amount of this InstrumentCashFlow.  # noqa: E501
+        :type amount: float
+        """
+
+        self._amount = amount
+
+    @property
+    def currency(self):
+        """Gets the currency of this InstrumentCashFlow.  # noqa: E501
+
+        The payment currency of the cash flow.  # noqa: E501
+
+        :return: The currency of this InstrumentCashFlow.  # noqa: E501
+        :rtype: str
+        """
+        return self._currency
+
+    @currency.setter
+    def currency(self, currency):
+        """Sets the currency of this InstrumentCashFlow.
+
+        The payment currency of the cash flow.  # noqa: E501
+
+        :param currency: The currency of this InstrumentCashFlow.  # noqa: E501
+        :type currency: str
+        """
+        if self.local_vars_configuration.client_side_validation and currency is None:  # noqa: E501
+            raise ValueError("Invalid value for `currency`, must not be `None`")  # noqa: E501
+
+        self._currency = currency
+
+    @property
+    def source_portfolio_id(self):
+        """Gets the source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
+
+
+        :return: The source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
+        :rtype: lusid.ResourceId
+        """
+        return self._source_portfolio_id
+
+    @source_portfolio_id.setter
+    def source_portfolio_id(self, source_portfolio_id):
+        """Sets the source_portfolio_id of this InstrumentCashFlow.
+
+
+        :param source_portfolio_id: The source_portfolio_id of this InstrumentCashFlow.  # noqa: E501
+        :type source_portfolio_id: lusid.ResourceId
+        """
+        if self.local_vars_configuration.client_side_validation and source_portfolio_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `source_portfolio_id`, must not be `None`")  # noqa: E501
+
+        self._source_portfolio_id = source_portfolio_id
+
+    @property
+    def source_transaction_id(self):
+        """Gets the source_transaction_id of this InstrumentCashFlow.  # noqa: E501
+
+        The identifier for the parent transaction on the instrument that will pay/receive this cash flow.  # noqa: E501
+
+        :return: The source_transaction_id of this InstrumentCashFlow.  # noqa: E501
+        :rtype: str
+        """
+        return self._source_transaction_id
+
+    @source_transaction_id.setter
+    def source_transaction_id(self, source_transaction_id):
+        """Sets the source_transaction_id of this InstrumentCashFlow.
+
+        The identifier for the parent transaction on the instrument that will pay/receive this cash flow.  # noqa: E501
+
+        :param source_transaction_id: The source_transaction_id of this InstrumentCashFlow.  # noqa: E501
+        :type source_transaction_id: str
+        """
+        if self.local_vars_configuration.client_side_validation and source_transaction_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `source_transaction_id`, must not be `None`")  # noqa: E501
+        if (self.local_vars_configuration.client_side_validation and
+                source_transaction_id is not None and len(source_transaction_id) < 1):
+            raise ValueError("Invalid value for `source_transaction_id`, length must be greater than or equal to `1`")  # noqa: E501
+
+        self._source_transaction_id = source_transaction_id
+
+    @property
+    def source_instrument_scope(self):
+        """Gets the source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
+
+        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
+
+        :return: The source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
+        :rtype: str
+        """
+        return self._source_instrument_scope
+
+    @source_instrument_scope.setter
+    def source_instrument_scope(self, source_instrument_scope):
+        """Sets the source_instrument_scope of this InstrumentCashFlow.
+
+        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
+
+        :param source_instrument_scope: The source_instrument_scope of this InstrumentCashFlow.  # noqa: E501
+        :type source_instrument_scope: str
+        """
+        if self.local_vars_configuration.client_side_validation and source_instrument_scope is None:  # noqa: E501
+            raise ValueError("Invalid value for `source_instrument_scope`, must not be `None`")  # noqa: E501
+        if (self.local_vars_configuration.client_side_validation and
+                source_instrument_scope is not None and len(source_instrument_scope) < 1):
+            raise ValueError("Invalid value for `source_instrument_scope`, length must be greater than or equal to `1`")  # noqa: E501
+
+        self._source_instrument_scope = source_instrument_scope
+
+    @property
+    def source_instrument_id(self):
+        """Gets the source_instrument_id of this InstrumentCashFlow.  # noqa: E501
+
+        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
+
+        :return: The source_instrument_id of this InstrumentCashFlow.  # noqa: E501
+        :rtype: str
+        """
+        return self._source_instrument_id
+
+    @source_instrument_id.setter
+    def source_instrument_id(self, source_instrument_id):
+        """Sets the source_instrument_id of this InstrumentCashFlow.
+
+        The unique Lusid Instrument Id (LUID) of the instrument that the holding is in.  # noqa: E501
+
+        :param source_instrument_id: The source_instrument_id of this InstrumentCashFlow.  # noqa: E501
+        :type source_instrument_id: str
+        """
+        if self.local_vars_configuration.client_side_validation and source_instrument_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `source_instrument_id`, must not be `None`")  # noqa: E501
+        if (self.local_vars_configuration.client_side_validation and
+                source_instrument_id is not None and len(source_instrument_id) < 1):
+            raise ValueError("Invalid value for `source_instrument_id`, length must be greater than or equal to `1`")  # noqa: E501
+
+        self._source_instrument_id = source_instrument_id
+
+    @property
+    def diagnostics(self):
+        """Gets the diagnostics of this InstrumentCashFlow.  # noqa: E501
+
+        Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.  # noqa: E501
+
+        :return: The diagnostics of this InstrumentCashFlow.  # noqa: E501
+        :rtype: dict(str, str)
+        """
+        return self._diagnostics
+
+    @diagnostics.setter
+    def diagnostics(self, diagnostics):
+        """Sets the diagnostics of this InstrumentCashFlow.
+
+        Whilst a cash flow is defined by an (amount,ccy) pair and the date it is paid on there is additional information required for diagnostics. This includes a range of information and can be empty in the case of a simple cash quantity or where further information is not available. Typical information includes items such as reset dates, RIC, accrual start/end, number of days and curve data.  # noqa: E501
+
+        :param diagnostics: The diagnostics of this InstrumentCashFlow.  # noqa: E501
+        :type diagnostics: dict(str, str)
+        """
+        if self.local_vars_configuration.client_side_validation and diagnostics is None:  # noqa: E501
+            raise ValueError("Invalid value for `diagnostics`, must not be `None`")  # noqa: E501
+
+        self._diagnostics = diagnostics
+
+    @property
+    def links(self):
+        """Gets the links of this InstrumentCashFlow.  # noqa: E501
+
+        Collection of links.  # noqa: E501
+
+        :return: The links of this InstrumentCashFlow.  # noqa: E501
+        :rtype: list[lusid.Link]
+        """
+        return self._links
+
+    @links.setter
+    def links(self, links):
+        """Sets the links of this InstrumentCashFlow.
+
+        Collection of links.  # noqa: E501
+
+        :param links: The links of this InstrumentCashFlow.  # noqa: E501
+        :type links: list[lusid.Link]
+        """
+
+        self._links = links
+
+    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, InstrumentCashFlow):
+            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, InstrumentCashFlow):
+            return True
+
+        return self.to_dict() != other.to_dict()

lusid/models/instrument_definition.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_definition_format.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_event.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_event_configuration.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """
@@ -92,6 +92,9 @@ class InstrumentEventConfiguration(object):
         :param transaction_template_scopes: The transaction_template_scopes of this InstrumentEventConfiguration.  # noqa: E501
         :type transaction_template_scopes: list[str]
         """
+        if (self.local_vars_configuration.client_side_validation and
+                transaction_template_scopes is not None and len(transaction_template_scopes) > 1):
+            raise ValueError("Invalid value for `transaction_template_scopes`, number of items must be less than or equal to `1`")  # noqa: E501
 
         self._transaction_template_scopes = transaction_template_scopes
 

lusid/models/instrument_event_holder.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_event_instruction.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_event_instruction_request.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_event_instructions_response.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_id_type_descriptor.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_id_value.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_leg.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_leg_all_of.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_list.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_list_all_of.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_list_compliance_parameter.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_match.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_models.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_properties.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/instrument_search_property.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/interest_rate_swap.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/interest_rate_swap_all_of.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/interest_rate_swaption.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/interest_rate_swaption_all_of.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/ir_vol_cube_data.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """

lusid/models/ir_vol_cube_data_all_of.py

@@ -5,7 +5,7 @@
 
     FINBOURNE Technology  # noqa: E501
 
-    The version of the OpenAPI document: 1.1.158
+    The version of the OpenAPI document: 1.1.162
     Contact: info@finbourne.com
     Generated by: https://openapi-generator.tech
 """