lusid-sdk 1.1.126__py3-none-any.whl → 1.1.139__py3-none-any.whl

lusid/models/scrip_dividend_event_all_of.py

@@ -0,0 +1,306 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    The version of the OpenAPI document: 1.1.139
+    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 ScripDividendEventAllOf(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 = {
+        'announcement_date': 'datetime',
+        'ex_date': 'datetime',
+        'record_date': 'datetime',
+        'payment_date': 'datetime',
+        'units_ratio': 'UnitsRatio',
+        'instrument_event_type': 'str'
+    }
+
+    attribute_map = {
+        'announcement_date': 'announcementDate',
+        'ex_date': 'exDate',
+        'record_date': 'recordDate',
+        'payment_date': 'paymentDate',
+        'units_ratio': 'unitsRatio',
+        'instrument_event_type': 'instrumentEventType'
+    }
+
+    required_map = {
+        'announcement_date': 'optional',
+        'ex_date': 'required',
+        'record_date': 'optional',
+        'payment_date': 'required',
+        'units_ratio': 'required',
+        'instrument_event_type': 'required'
+    }
+
+    def __init__(self, announcement_date=None, ex_date=None, record_date=None, payment_date=None, units_ratio=None, instrument_event_type=None, local_vars_configuration=None):  # noqa: E501
+        """ScripDividendEventAllOf - a model defined in OpenAPI"
+        
+        :param announcement_date:  Date on which the dividend was announced / declared.
+        :type announcement_date: datetime
+        :param ex_date:  The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate. (required)
+        :type ex_date: datetime
+        :param record_date:  Date you have to be the holder of record in order to participate in the tender.
+        :type record_date: datetime
+        :param payment_date:  The date the company pays out dividends to shareholders. (required)
+        :type payment_date: datetime
+        :param units_ratio:  (required)
+        :type units_ratio: lusid.UnitsRatio
+        :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._announcement_date = None
+        self._ex_date = None
+        self._record_date = None
+        self._payment_date = None
+        self._units_ratio = None
+        self._instrument_event_type = None
+        self.discriminator = None
+
+        self.announcement_date = announcement_date
+        self.ex_date = ex_date
+        self.record_date = record_date
+        self.payment_date = payment_date
+        self.units_ratio = units_ratio
+        self.instrument_event_type = instrument_event_type
+
+    @property
+    def announcement_date(self):
+        """Gets the announcement_date of this ScripDividendEventAllOf.  # noqa: E501
+
+        Date on which the dividend was announced / declared.  # noqa: E501
+
+        :return: The announcement_date of this ScripDividendEventAllOf.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._announcement_date
+
+    @announcement_date.setter
+    def announcement_date(self, announcement_date):
+        """Sets the announcement_date of this ScripDividendEventAllOf.
+
+        Date on which the dividend was announced / declared.  # noqa: E501
+
+        :param announcement_date: The announcement_date of this ScripDividendEventAllOf.  # noqa: E501
+        :type announcement_date: datetime
+        """
+
+        self._announcement_date = announcement_date
+
+    @property
+    def ex_date(self):
+        """Gets the ex_date of this ScripDividendEventAllOf.  # noqa: E501
+
+        The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.  # noqa: E501
+
+        :return: The ex_date of this ScripDividendEventAllOf.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._ex_date
+
+    @ex_date.setter
+    def ex_date(self, ex_date):
+        """Sets the ex_date of this ScripDividendEventAllOf.
+
+        The first business day on which the dividend is not owed to the buying party.  Typically this is T-1 from the RecordDate.  # noqa: E501
+
+        :param ex_date: The ex_date of this ScripDividendEventAllOf.  # noqa: E501
+        :type ex_date: datetime
+        """
+        if self.local_vars_configuration.client_side_validation and ex_date is None:  # noqa: E501
+            raise ValueError("Invalid value for `ex_date`, must not be `None`")  # noqa: E501
+
+        self._ex_date = ex_date
+
+    @property
+    def record_date(self):
+        """Gets the record_date of this ScripDividendEventAllOf.  # noqa: E501
+
+        Date you have to be the holder of record in order to participate in the tender.  # noqa: E501
+
+        :return: The record_date of this ScripDividendEventAllOf.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._record_date
+
+    @record_date.setter
+    def record_date(self, record_date):
+        """Sets the record_date of this ScripDividendEventAllOf.
+
+        Date you have to be the holder of record in order to participate in the tender.  # noqa: E501
+
+        :param record_date: The record_date of this ScripDividendEventAllOf.  # noqa: E501
+        :type record_date: datetime
+        """
+
+        self._record_date = record_date
+
+    @property
+    def payment_date(self):
+        """Gets the payment_date of this ScripDividendEventAllOf.  # noqa: E501
+
+        The date the company pays out dividends to shareholders.  # noqa: E501
+
+        :return: The payment_date of this ScripDividendEventAllOf.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._payment_date
+
+    @payment_date.setter
+    def payment_date(self, payment_date):
+        """Sets the payment_date of this ScripDividendEventAllOf.
+
+        The date the company pays out dividends to shareholders.  # noqa: E501
+
+        :param payment_date: The payment_date of this ScripDividendEventAllOf.  # 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 units_ratio(self):
+        """Gets the units_ratio of this ScripDividendEventAllOf.  # noqa: E501
+
+
+        :return: The units_ratio of this ScripDividendEventAllOf.  # noqa: E501
+        :rtype: lusid.UnitsRatio
+        """
+        return self._units_ratio
+
+    @units_ratio.setter
+    def units_ratio(self, units_ratio):
+        """Sets the units_ratio of this ScripDividendEventAllOf.
+
+
+        :param units_ratio: The units_ratio of this ScripDividendEventAllOf.  # noqa: E501
+        :type units_ratio: lusid.UnitsRatio
+        """
+        if self.local_vars_configuration.client_side_validation and units_ratio is None:  # noqa: E501
+            raise ValueError("Invalid value for `units_ratio`, must not be `None`")  # noqa: E501
+
+        self._units_ratio = units_ratio
+
+    @property
+    def instrument_event_type(self):
+        """Gets the instrument_event_type of this ScripDividendEventAllOf.  # 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 ScripDividendEventAllOf.  # 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 ScripDividendEventAllOf.
+
+        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 ScripDividendEventAllOf.  # 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())
+
+    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, ScripDividendEventAllOf):
+            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, ScripDividendEventAllOf):
+            return True
+
+        return self.to_dict() != other.to_dict()

lusid/models/script_map_reference.py

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

lusid/models/security_election.py

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

lusid/models/sequence_definition.py

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

lusid/models/set_legal_entity_identifiers_request.py

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

lusid/models/set_legal_entity_properties_request.py

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

lusid/models/set_person_identifiers_request.py

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

lusid/models/set_person_properties_request.py

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

lusid/models/side_configuration_data.py

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

lusid/models/side_definition.py

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

lusid/models/side_definition_request.py

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

lusid/models/sides_definition_request.py

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

lusid/models/simple_cash_flow_loan.py

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

lusid/models/simple_cash_flow_loan_all_of.py

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

lusid/models/simple_instrument.py

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

lusid/models/simple_instrument_all_of.py

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

lusid/models/staged_modifications_info.py

@@ -0,0 +1,208 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    The version of the OpenAPI document: 1.1.139
+    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 StagedModificationsInfo(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 = {
+        'count_pending': 'int',
+        'href_pending': 'str',
+        'ids_previewed': 'list[str]'
+    }
+
+    attribute_map = {
+        'count_pending': 'countPending',
+        'href_pending': 'hrefPending',
+        'ids_previewed': 'idsPreviewed'
+    }
+
+    required_map = {
+        'count_pending': 'required',
+        'href_pending': 'required',
+        'ids_previewed': 'optional'
+    }
+
+    def __init__(self, count_pending=None, href_pending=None, ids_previewed=None, local_vars_configuration=None):  # noqa: E501
+        """StagedModificationsInfo - a model defined in OpenAPI"
+        
+        :param count_pending:  The number of staged modifications for the entity with a status of Pending for the requested asAt. (required)
+        :type count_pending: int
+        :param href_pending:  Link to the list staged modifications endpoint, filtered by entityType, entityUniqueId and status (= Pending). (required)
+        :type href_pending: str
+        :param ids_previewed:  An array of the ids of any StagedModifications being previewed.
+        :type ids_previewed: list[str]
+
+        """  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration.get_default_copy()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._count_pending = None
+        self._href_pending = None
+        self._ids_previewed = None
+        self.discriminator = None
+
+        self.count_pending = count_pending
+        self.href_pending = href_pending
+        self.ids_previewed = ids_previewed
+
+    @property
+    def count_pending(self):
+        """Gets the count_pending of this StagedModificationsInfo.  # noqa: E501
+
+        The number of staged modifications for the entity with a status of Pending for the requested asAt.  # noqa: E501
+
+        :return: The count_pending of this StagedModificationsInfo.  # noqa: E501
+        :rtype: int
+        """
+        return self._count_pending
+
+    @count_pending.setter
+    def count_pending(self, count_pending):
+        """Sets the count_pending of this StagedModificationsInfo.
+
+        The number of staged modifications for the entity with a status of Pending for the requested asAt.  # noqa: E501
+
+        :param count_pending: The count_pending of this StagedModificationsInfo.  # noqa: E501
+        :type count_pending: int
+        """
+        if self.local_vars_configuration.client_side_validation and count_pending is None:  # noqa: E501
+            raise ValueError("Invalid value for `count_pending`, must not be `None`")  # noqa: E501
+
+        self._count_pending = count_pending
+
+    @property
+    def href_pending(self):
+        """Gets the href_pending of this StagedModificationsInfo.  # noqa: E501
+
+        Link to the list staged modifications endpoint, filtered by entityType, entityUniqueId and status (= Pending).  # noqa: E501
+
+        :return: The href_pending of this StagedModificationsInfo.  # noqa: E501
+        :rtype: str
+        """
+        return self._href_pending
+
+    @href_pending.setter
+    def href_pending(self, href_pending):
+        """Sets the href_pending of this StagedModificationsInfo.
+
+        Link to the list staged modifications endpoint, filtered by entityType, entityUniqueId and status (= Pending).  # noqa: E501
+
+        :param href_pending: The href_pending of this StagedModificationsInfo.  # noqa: E501
+        :type href_pending: str
+        """
+        if self.local_vars_configuration.client_side_validation and href_pending is None:  # noqa: E501
+            raise ValueError("Invalid value for `href_pending`, must not be `None`")  # noqa: E501
+
+        self._href_pending = href_pending
+
+    @property
+    def ids_previewed(self):
+        """Gets the ids_previewed of this StagedModificationsInfo.  # noqa: E501
+
+        An array of the ids of any StagedModifications being previewed.  # noqa: E501
+
+        :return: The ids_previewed of this StagedModificationsInfo.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._ids_previewed
+
+    @ids_previewed.setter
+    def ids_previewed(self, ids_previewed):
+        """Sets the ids_previewed of this StagedModificationsInfo.
+
+        An array of the ids of any StagedModifications being previewed.  # noqa: E501
+
+        :param ids_previewed: The ids_previewed of this StagedModificationsInfo.  # noqa: E501
+        :type ids_previewed: list[str]
+        """
+
+        self._ids_previewed = ids_previewed
+
+    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, StagedModificationsInfo):
+            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, StagedModificationsInfo):
+            return True
+
+        return self.to_dict() != other.to_dict()

lusid/models/step_schedule.py

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