lusid-sdk 2.1.582__py3-none-any.whl → 2.1.584__py3-none-any.whl

lusid/configuration.py

@@ -445,7 +445,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.11.7045\n"\
+               "Version of the API: 0.11.7057\n"\
                "SDK Package Version: {package_version}".\
                format(env=sys.platform, pyversion=sys.version, package_version=package_version)
 

lusid/models/additional_payment.py

@@ -25,9 +25,9 @@ class AdditionalPayment(BaseModel):
     """
     Record describing additional payment entity.  # noqa: E501
     """
-    amount: Union[StrictFloat, StrictInt] = Field(..., description="The upfront amount.")
-    currency: StrictStr = Field(..., description="The upfront currency.")
-    pay_date: datetime = Field(..., alias="payDate", description="Date when the upfront is paid.")
+    amount: Union[StrictFloat, StrictInt] = Field(..., description="The payment amount.")
+    currency: StrictStr = Field(..., description="The payment currency.")
+    pay_date: datetime = Field(..., alias="payDate", description="Date when the payment is made.")
     pay_receive: constr(strict=True, min_length=1) = Field(..., alias="payReceive", description="Is it pay or receive.    Supported string (enumeration) values are: [Pay, Receive].")
     __properties = ["amount", "currency", "payDate", "payReceive"]
 

lusid/models/cds_index.py

@@ -18,8 +18,9 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict, Optional, Union
-from pydantic.v1 import Field, StrictFloat, StrictInt, StrictStr, validator
+from typing import Any, Dict, List, Optional, Union
+from pydantic.v1 import Field, StrictFloat, StrictInt, StrictStr, conlist, validator
+from lusid.models.additional_payment import AdditionalPayment
 from lusid.models.basket import Basket
 from lusid.models.cds_flow_conventions import CdsFlowConventions
 from lusid.models.flow_convention_name import FlowConventionName
@@ -27,7 +28,7 @@ from lusid.models.lusid_instrument import LusidInstrument
 
 class CdsIndex(LusidInstrument):
     """
-    LUSID representation of a Credit Default Swap Index (CDX).                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | ProtectionLeg | Payments made by the protection seller in the case of default across all CDS instruments in the index. |  | 2 | PremiumLeg | The premium payments made by the protection buyer across all CDS instruments in the index. |  # noqa: E501
+    LUSID representation of a Credit Default Swap Index (CDX).                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | ProtectionLeg | Payments made by the protection seller in the case of default across all CDS instruments in the index. |  | 2 | PremiumLeg | The premium payments made by the protection buyer across all CDS instruments in the index. |  | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). |  # noqa: E501
     """
     start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
     maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.  For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as  Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
@@ -37,9 +38,10 @@ class CdsIndex(LusidInstrument):
     basket: Optional[Basket] = None
     convention_name: Optional[FlowConventionName] = Field(None, alias="conventionName")
     notional: Union[StrictFloat, StrictInt] = Field(..., description="The notional quantity that applies to both the premium and protection legs.")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentType", "startDate", "maturityDate", "flowConventions", "couponRate", "identifiers", "basket", "conventionName", "notional"]
+    __properties = ["instrumentType", "startDate", "maturityDate", "flowConventions", "couponRate", "identifiers", "basket", "conventionName", "notional", "additionalPayments"]
 
     @validator('instrument_type')
     def instrument_type_validate_enum(cls, value):
@@ -82,11 +84,23 @@ class CdsIndex(LusidInstrument):
         # override the default output from pydantic by calling `to_dict()` of convention_name
         if self.convention_name:
             _dict['conventionName'] = self.convention_name.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in additional_payments (list)
+        _items = []
+        if self.additional_payments:
+            for _item in self.additional_payments:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['additionalPayments'] = _items
         # 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 additional_payments (nullable) is None
+        # and __fields_set__ contains the field
+        if self.additional_payments is None and "additional_payments" in self.__fields_set__:
+            _dict['additionalPayments'] = None
+
         return _dict
 
     @classmethod
@@ -107,7 +121,8 @@ class CdsIndex(LusidInstrument):
             "identifiers": obj.get("identifiers"),
             "basket": Basket.from_dict(obj.get("basket")) if obj.get("basket") is not None else None,
             "convention_name": FlowConventionName.from_dict(obj.get("conventionName")) if obj.get("conventionName") is not None else None,
-            "notional": obj.get("notional")
+            "notional": obj.get("notional"),
+            "additional_payments": [AdditionalPayment.from_dict(_item) for _item in obj.get("additionalPayments")] if obj.get("additionalPayments") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

lusid/models/credit_default_swap.py

@@ -18,8 +18,9 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict, Optional, Union
-from pydantic.v1 import Field, StrictFloat, StrictInt, StrictStr, constr, validator
+from typing import Any, Dict, List, Optional, Union
+from pydantic.v1 import Field, StrictFloat, StrictInt, StrictStr, conlist, constr, validator
+from lusid.models.additional_payment import AdditionalPayment
 from lusid.models.cds_flow_conventions import CdsFlowConventions
 from lusid.models.cds_protection_detail_specification import CdsProtectionDetailSpecification
 from lusid.models.flow_convention_name import FlowConventionName
@@ -27,9 +28,9 @@ from lusid.models.lusid_instrument import LusidInstrument
 
 class CreditDefaultSwap(LusidInstrument):
     """
-    LUSID representation of a Credit Default Swap (CDS).                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | ProtectionLeg | Cash flows occurring in the case of default. |  | 2 | PremiumLeg | The premium payments made by the protection buyer. |  # noqa: E501
+    LUSID representation of a Credit Default Swap (CDS).                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | ProtectionLeg | Cash flows occurring in the case of default. |  | 2 | PremiumLeg | The premium payments made by the protection buyer. |  | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). |  # noqa: E501
     """
-    ticker: constr(strict=True, min_length=1) = Field(..., description="A ticker to uniquely specify then entity against which the cds is written.")
+    ticker: constr(strict=True, min_length=1) = Field(..., description="A ticker to uniquely specify the entity against which the CDS is written.")
     start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
     maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.  For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as  Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
     flow_conventions: Optional[CdsFlowConventions] = Field(None, alias="flowConventions")
@@ -37,9 +38,10 @@ class CreditDefaultSwap(LusidInstrument):
     convention_name: Optional[FlowConventionName] = Field(None, alias="conventionName")
     notional: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The notional protected by the Credit Default Swap")
     protection_detail_specification: CdsProtectionDetailSpecification = Field(..., alias="protectionDetailSpecification")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentType", "ticker", "startDate", "maturityDate", "flowConventions", "couponRate", "conventionName", "notional", "protectionDetailSpecification"]
+    __properties = ["instrumentType", "ticker", "startDate", "maturityDate", "flowConventions", "couponRate", "conventionName", "notional", "protectionDetailSpecification", "additionalPayments"]
 
     @validator('instrument_type')
     def instrument_type_validate_enum(cls, value):
@@ -82,6 +84,13 @@ class CreditDefaultSwap(LusidInstrument):
         # override the default output from pydantic by calling `to_dict()` of protection_detail_specification
         if self.protection_detail_specification:
             _dict['protectionDetailSpecification'] = self.protection_detail_specification.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in additional_payments (list)
+        _items = []
+        if self.additional_payments:
+            for _item in self.additional_payments:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['additionalPayments'] = _items
         # 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():
@@ -92,6 +101,11 @@ class CreditDefaultSwap(LusidInstrument):
         if self.notional is None and "notional" in self.__fields_set__:
             _dict['notional'] = None
 
+        # set to None if additional_payments (nullable) is None
+        # and __fields_set__ contains the field
+        if self.additional_payments is None and "additional_payments" in self.__fields_set__:
+            _dict['additionalPayments'] = None
+
         return _dict
 
     @classmethod
@@ -112,7 +126,8 @@ class CreditDefaultSwap(LusidInstrument):
             "coupon_rate": obj.get("couponRate"),
             "convention_name": FlowConventionName.from_dict(obj.get("conventionName")) if obj.get("conventionName") is not None else None,
             "notional": obj.get("notional"),
-            "protection_detail_specification": CdsProtectionDetailSpecification.from_dict(obj.get("protectionDetailSpecification")) if obj.get("protectionDetailSpecification") is not None else None
+            "protection_detail_specification": CdsProtectionDetailSpecification.from_dict(obj.get("protectionDetailSpecification")) if obj.get("protectionDetailSpecification") is not None else None,
+            "additional_payments": [AdditionalPayment.from_dict(_item) for _item in obj.get("additionalPayments")] if obj.get("additionalPayments") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

lusid/models/equity_swap.py

@@ -18,15 +18,16 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict, Optional, Union
-from pydantic.v1 import Field, StrictBool, StrictFloat, StrictInt, StrictStr, constr, validator
+from typing import Any, Dict, List, Optional, Union
+from pydantic.v1 import Field, StrictBool, StrictFloat, StrictInt, StrictStr, conlist, constr, validator
+from lusid.models.additional_payment import AdditionalPayment
 from lusid.models.flow_conventions import FlowConventions
 from lusid.models.instrument_leg import InstrumentLeg
 from lusid.models.lusid_instrument import LusidInstrument
 
 class EquitySwap(LusidInstrument):
     """
-    LUSID representation of an Equity Swap.                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | EquityLeg | Cash flows relating to the performance of the underlying equity. |  | 2 | FundingLeg | The funding leg of the swap. |  | 3 | EquityDividendLeg | Cash flows relating to dividend payments on the underlying equity (optional). |  # noqa: E501
+    LUSID representation of an Equity Swap.                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | EquityLeg | Cash flows relating to the performance of the underlying equity. |  | 2 | FundingLeg | The funding leg of the swap. |  | 3 | EquityDividendLeg | Cash flows relating to dividend payments on the underlying equity (optional). |  | 4 | AdditionalPayments | Cash flows relating to any additional payments (optional). |  # noqa: E501
     """
     start_date: datetime = Field(..., alias="startDate", description="The start date of the EquitySwap.")
     maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.  For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as  Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
@@ -39,9 +40,10 @@ class EquitySwap(LusidInstrument):
     quantity: Union[StrictFloat, StrictInt] = Field(..., description="The quantity or number of shares in the Equity Swap.")
     underlying_identifier: constr(strict=True, min_length=1) = Field(..., alias="underlyingIdentifier", description="External market codes and identifiers for the EquitySwap, e.g. RIC.    Supported string (enumeration) values are: [LusidInstrumentId, Isin, Sedol, Cusip, ClientInternal, Figi, RIC, QuotePermId, REDCode, BBGId, ICECode].")
     equity_swap_dividend_payment_timing: Optional[StrictStr] = Field(None, alias="equitySwapDividendPaymentTiming", description="Determines how the payment of dividends is handled for the equity swap.  Defaults to paying at the next Equity coupon date.                Supported string (enumeration) values are: [PayAtNextEquityCouponDate, PayAtMaturityOfSwap, PayAtNextFundingLegCouponDate, PayAtPaymentDateOfDividendEvent].")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven equity swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentType", "startDate", "maturityDate", "code", "equityFlowConventions", "fundingLeg", "includeDividends", "initialPrice", "notionalReset", "quantity", "underlyingIdentifier", "equitySwapDividendPaymentTiming"]
+    __properties = ["instrumentType", "startDate", "maturityDate", "code", "equityFlowConventions", "fundingLeg", "includeDividends", "initialPrice", "notionalReset", "quantity", "underlyingIdentifier", "equitySwapDividendPaymentTiming", "additionalPayments"]
 
     @validator('instrument_type')
     def instrument_type_validate_enum(cls, value):
@@ -81,6 +83,13 @@ class EquitySwap(LusidInstrument):
         # override the default output from pydantic by calling `to_dict()` of funding_leg
         if self.funding_leg:
             _dict['fundingLeg'] = self.funding_leg.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in additional_payments (list)
+        _items = []
+        if self.additional_payments:
+            for _item in self.additional_payments:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['additionalPayments'] = _items
         # 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():
@@ -91,6 +100,11 @@ class EquitySwap(LusidInstrument):
         if self.equity_swap_dividend_payment_timing is None and "equity_swap_dividend_payment_timing" in self.__fields_set__:
             _dict['equitySwapDividendPaymentTiming'] = None
 
+        # set to None if additional_payments (nullable) is None
+        # and __fields_set__ contains the field
+        if self.additional_payments is None and "additional_payments" in self.__fields_set__:
+            _dict['additionalPayments'] = None
+
         return _dict
 
     @classmethod
@@ -114,7 +128,8 @@ class EquitySwap(LusidInstrument):
             "notional_reset": obj.get("notionalReset"),
             "quantity": obj.get("quantity"),
             "underlying_identifier": obj.get("underlyingIdentifier"),
-            "equity_swap_dividend_payment_timing": obj.get("equitySwapDividendPaymentTiming")
+            "equity_swap_dividend_payment_timing": obj.get("equitySwapDividendPaymentTiming"),
+            "additional_payments": [AdditionalPayment.from_dict(_item) for _item in obj.get("additionalPayments")] if obj.get("additionalPayments") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

lusid/models/inflation_swap.py

@@ -18,23 +18,25 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict
-from pydantic.v1 import Field, StrictStr, validator
+from typing import Any, Dict, List, Optional
+from pydantic.v1 import Field, StrictStr, conlist, validator
+from lusid.models.additional_payment import AdditionalPayment
 from lusid.models.fixed_leg import FixedLeg
 from lusid.models.inflation_leg import InflationLeg
 from lusid.models.lusid_instrument import LusidInstrument
 
 class InflationSwap(LusidInstrument):
     """
-    LUSID representation of an Inflation Swap.  The implementation supports the following swap types:  * Zero Coupon inflation swap, with a single payment at maturity.  * LPI Swap (capped and floored)  * Year on Year inflation swap                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | InflationLeg | Cash flows with a rate relating to an underlying inflation index. |  | 2 | FixedLeg | Cash flows with a fixed rate. |  # noqa: E501
+    LUSID representation of an Inflation Swap.  The implementation supports the following swap types:  * Zero Coupon inflation swap, with a single payment at maturity.  * LPI Swap (capped and floored)  * Year on Year inflation swap                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | InflationLeg | Cash flows with a rate relating to an underlying inflation index. |  | 2 | FixedLeg | Cash flows with a fixed rate. |  | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). |  # noqa: E501
     """
     start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
     maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.  For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as  Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
     inflation_leg: InflationLeg = Field(..., alias="inflationLeg")
     fixed_leg: FixedLeg = Field(..., alias="fixedLeg")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven inflation swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentType", "startDate", "maturityDate", "inflationLeg", "fixedLeg"]
+    __properties = ["instrumentType", "startDate", "maturityDate", "inflationLeg", "fixedLeg", "additionalPayments"]
 
     @validator('instrument_type')
     def instrument_type_validate_enum(cls, value):
@@ -74,11 +76,23 @@ class InflationSwap(LusidInstrument):
         # override the default output from pydantic by calling `to_dict()` of fixed_leg
         if self.fixed_leg:
             _dict['fixedLeg'] = self.fixed_leg.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in additional_payments (list)
+        _items = []
+        if self.additional_payments:
+            for _item in self.additional_payments:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['additionalPayments'] = _items
         # 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 additional_payments (nullable) is None
+        # and __fields_set__ contains the field
+        if self.additional_payments is None and "additional_payments" in self.__fields_set__:
+            _dict['additionalPayments'] = None
+
         return _dict
 
     @classmethod
@@ -95,7 +109,8 @@ class InflationSwap(LusidInstrument):
             "start_date": obj.get("startDate"),
             "maturity_date": obj.get("maturityDate"),
             "inflation_leg": InflationLeg.from_dict(obj.get("inflationLeg")) if obj.get("inflationLeg") is not None else None,
-            "fixed_leg": FixedLeg.from_dict(obj.get("fixedLeg")) if obj.get("fixedLeg") is not None else None
+            "fixed_leg": FixedLeg.from_dict(obj.get("fixedLeg")) if obj.get("fixedLeg") is not None else None,
+            "additional_payments": [AdditionalPayment.from_dict(_item) for _item in obj.get("additionalPayments")] if obj.get("additionalPayments") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

lusid/models/interest_rate_swap.py

@@ -33,7 +33,7 @@ class InterestRateSwap(LusidInstrument):
     is_non_deliverable: Optional[StrictBool] = Field(None, alias="isNonDeliverable", description="Is the contract an IRS of \"Non-Deliverable\" type, meaning a single payment in the settlement currency based on the difference between  the fixed and floating rates.")
     legs: conlist(InstrumentLeg) = Field(..., description="The set of instrument legs that define the swap instrument, these should be FloatingLeg or FixedLeg.")
     settlement_ccy: Optional[StrictStr] = Field(None, alias="settlementCcy", description="Settlement currency if IRS is non-deliverable.")
-    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven fixed-floating swap.  The dates must be distinct and either all payments are Pay or all payments are receive")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven fixed-floating swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
     __properties = ["instrumentType", "startDate", "maturityDate", "isNonDeliverable", "legs", "settlementCcy", "additionalPayments"]

lusid/models/total_return_swap.py

@@ -18,23 +18,25 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from typing import Any, Dict
-from pydantic.v1 import Field, StrictStr, validator
+from typing import Any, Dict, List, Optional
+from pydantic.v1 import Field, StrictStr, conlist, validator
+from lusid.models.additional_payment import AdditionalPayment
 from lusid.models.asset_leg import AssetLeg
 from lusid.models.instrument_leg import InstrumentLeg
 from lusid.models.lusid_instrument import LusidInstrument
 
 class TotalReturnSwap(LusidInstrument):
     """
-    A swap in which one party makes payments based on leg rates (fixed or floating) while the other party makes payments based on the return of an underlying instrument.  The underlying instrument can be provided as an inline economic definition or as a reference instrument pointing to an already upserted instrument.  A reference instrument in this case would consist of instrument scope, instrument id and instrument id type (ISIN, LUID etc.).                Note that TRS currently only supports an asset of Bond or ComplexBond, no other instruments are allowed.  Support for additional instrument types will be added in the future.                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | AssetLeg | Cash flows relating to the returns generated by an underlying bond. |  | 2 | FundingLeg | The funding leg of the swap. |  # noqa: E501
+    A swap in which one party makes payments based on leg rates (fixed or floating) while the other party makes payments based on the return of an underlying instrument.  The underlying instrument can be provided as an inline economic definition or as a reference instrument pointing to an already upserted instrument.  A reference instrument in this case would consist of instrument scope, instrument id and instrument id type (ISIN, LUID etc.).                Note that TRS currently only supports an asset of Bond or ComplexBond, no other instruments are allowed.  Support for additional instrument types will be added in the future.                This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252).                | Leg Index | Leg Identifier | Description |  | --------- | -------------- | ----------- |  | 1 | AssetLeg | Cash flows relating to the returns generated by an underlying bond. |  | 2 | FundingLeg | The funding leg of the swap. |  | 3 | AdditionalPayments | Cash flows relating to any additional payments (optional). |  # noqa: E501
     """
     start_date: datetime = Field(..., alias="startDate", description="The start date of the instrument. This is normally synonymous with the trade-date.")
     maturity_date: datetime = Field(..., alias="maturityDate", description="The final maturity date of the instrument. This means the last date on which the instruments makes a payment of any amount.  For the avoidance of doubt, that is not necessarily prior to its last sensitivity date for the purposes of risk; e.g. instruments such as  Constant Maturity Swaps (CMS) often have sensitivities to rates that may well be observed or set prior to the maturity date, but refer to a termination date beyond it.")
     asset_leg: AssetLeg = Field(..., alias="assetLeg")
     funding_leg: InstrumentLeg = Field(..., alias="fundingLeg")
+    additional_payments: Optional[conlist(AdditionalPayment)] = Field(None, alias="additionalPayments", description="Optional additional payments at a given date e.g. to level off an uneven total return swap.  The dates must be distinct and either all payments are Pay or all payments are Receive.")
     instrument_type: StrictStr = Field(..., alias="instrumentType", description="The available values are: QuotedSecurity, InterestRateSwap, FxForward, Future, ExoticInstrument, FxOption, CreditDefaultSwap, InterestRateSwaption, Bond, EquityOption, FixedLeg, FloatingLeg, BespokeCashFlowsLeg, Unknown, TermDeposit, ContractForDifference, EquitySwap, CashPerpetual, CapFloor, CashSettled, CdsIndex, Basket, FundingLeg, FxSwap, ForwardRateAgreement, SimpleInstrument, Repo, Equity, ExchangeTradedOption, ReferenceInstrument, ComplexBond, InflationLinkedBond, InflationSwap, SimpleCashFlowLoan, TotalReturnSwap, InflationLeg, FundShareClass, FlexibleLoan, UnsettledCash, Cash, MasteredInstrument, LoanFacility")
     additional_properties: Dict[str, Any] = {}
-    __properties = ["instrumentType", "startDate", "maturityDate", "assetLeg", "fundingLeg"]
+    __properties = ["instrumentType", "startDate", "maturityDate", "assetLeg", "fundingLeg", "additionalPayments"]
 
     @validator('instrument_type')
     def instrument_type_validate_enum(cls, value):
@@ -74,11 +76,23 @@ class TotalReturnSwap(LusidInstrument):
         # override the default output from pydantic by calling `to_dict()` of funding_leg
         if self.funding_leg:
             _dict['fundingLeg'] = self.funding_leg.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in additional_payments (list)
+        _items = []
+        if self.additional_payments:
+            for _item in self.additional_payments:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['additionalPayments'] = _items
         # 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 additional_payments (nullable) is None
+        # and __fields_set__ contains the field
+        if self.additional_payments is None and "additional_payments" in self.__fields_set__:
+            _dict['additionalPayments'] = None
+
         return _dict
 
     @classmethod
@@ -95,7 +109,8 @@ class TotalReturnSwap(LusidInstrument):
             "start_date": obj.get("startDate"),
             "maturity_date": obj.get("maturityDate"),
             "asset_leg": AssetLeg.from_dict(obj.get("assetLeg")) if obj.get("assetLeg") is not None else None,
-            "funding_leg": InstrumentLeg.from_dict(obj.get("fundingLeg")) if obj.get("fundingLeg") is not None else None
+            "funding_leg": InstrumentLeg.from_dict(obj.get("fundingLeg")) if obj.get("fundingLeg") is not None else None,
+            "additional_payments": [AdditionalPayment.from_dict(_item) for _item in obj.get("additionalPayments")] if obj.get("additionalPayments") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

{lusid_sdk-2.1.582.dist-info → lusid_sdk-2.1.584.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.582
+Version: 2.1.584
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT

{lusid_sdk-2.1.582.dist-info → lusid_sdk-2.1.584.dist-info}/RECORD

@@ -70,7 +70,7 @@ lusid/api/translation_api.py,sha256=nIyuLncCvVC5k2d7Nm32zR8AQ1dkrVm1OThkmELY_OM,
 lusid/api/workspace_api.py,sha256=mYQPqFUVf1VKYeWQUV5VkcdSqwejSmPDGd66Az86-_E,191319
 lusid/api_client.py,sha256=ewMTmf9SRurY8pYnUx9jy24RdldPCOa4US38pnrVxjA,31140
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=ssJbORuUv1V6d5VGVjClw4qQCvRljXsUBdEtdiAuXeo,17972
+lusid/configuration.py,sha256=ndmt73oY2T1MRcDodi4L981Pz7cDlUYLnk1w7ErOvC0,17972
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=dzDHEzpn-9smd2-_UMWQzeyX6Ha4jGf6fnqx7qxKxNI,630
 lusid/extensions/api_client.py,sha256=GzygWg_h603QK1QS2HvAijuE2R1TnvoF6-Yg0CeM3ug,30943
@@ -109,7 +109,7 @@ lusid/models/accumulation_event.py,sha256=4lTtlXleReQJlgAHexzuPzEJ8c6lgQ_Hv4lqlv
 lusid/models/action_id.py,sha256=NuJ7So7BAckiGCTpPdnwCmGVUEtsImy8r7PFLRYb6Ok,2057
 lusid/models/add_business_days_to_date_request.py,sha256=AfWmdr91A1Wpf0yT6CEEymkHYLXYha5Lll3EXe8FDtE,2640
 lusid/models/add_business_days_to_date_response.py,sha256=wWo01x8xabbdMWzv73T7nRNBsKi1LYXJWTSaj4VCnWs,2013
-lusid/models/additional_payment.py,sha256=YrUygIdtiNQAMyek-TtBhOmKj2KJ3BiAd4HYztYQr9o,2534
+lusid/models/additional_payment.py,sha256=TRuvS77hMMTov9wq1_ftBdNtmF7BzBDXJoiB4g8qUUA,2534
 lusid/models/address_definition.py,sha256=zTk3p8hfx0CcP_LcHSihJ8bKqT8R5p6RJe3h7mL4yYQ,4999
 lusid/models/address_key_compliance_parameter.py,sha256=LWG_jU7-xkSG5r8X_C_ssgObWV6NgVg1dUNemShn0cw,5396
 lusid/models/address_key_definition.py,sha256=ZBOa_DoY_hGC1jaMwKERn1sFhqsk2YsP1HZ0F8tQDek,3212
@@ -212,7 +212,7 @@ lusid/models/cash_offer_election.py,sha256=qefe020_tlp2w0Q1ohYzAC-q-t4m7UsRYl_mO
 lusid/models/cash_perpetual.py,sha256=43DlKqPbLiyBO9RH9ZOzwA9aDgG6KtMOAodz-KJE1iY,5364
 lusid/models/cds_credit_event.py,sha256=I-z3-YvZ06hVim-FrzapuYIonzaowhQ6okuQwaAIOKM,7308
 lusid/models/cds_flow_conventions.py,sha256=_WpM6p1v-kxjbzRQu7DzK3cJNJqyr_rRkgjTEaRic1Y,8161
-lusid/models/cds_index.py,sha256=c9ABdiG9vIP1zTjdNlVQ2q9yzEFtrAZcu86-smRpTRw,8296
+lusid/models/cds_index.py,sha256=p2spEHBWaFWdd41oI03IvL-zuKKI3NLSQqfYvP24K3M,9548
 lusid/models/cds_protection_detail_specification.py,sha256=k0mkP4WGJFjfouhI6WtCnR4y2rx2yFwBelO8D33lbaE,3213
 lusid/models/cdx_credit_event.py,sha256=w-LYEWDHSCmQyzxy32dIjU_vl9oP21TFocs1a_hFV80,8068
 lusid/models/change.py,sha256=QHC1wtZL_TXDfSertnsg-tNRpkHkcbk5wk8O5rOjby4,5076
@@ -320,7 +320,7 @@ lusid/models/create_tax_rule_set_request.py,sha256=4K9Kysssj-zFpvE6tVu-DXyVJYu0Y
 lusid/models/create_trade_tickets_response.py,sha256=hMgaSmMWyWbpp2SQqg6p9fnMrUjNE6F35mo4fmvwf2M,2961
 lusid/models/create_transaction_portfolio_request.py,sha256=MEsPFBS6TxHORxj_5Y-8oFnmvwHIZuxFJosY5vg8Mfo,11818
 lusid/models/create_unit_definition.py,sha256=hPfMi0Wew-HYzTQEaZ_wfDnN1dKMW6KYGB8kgyXjwlU,3418
-lusid/models/credit_default_swap.py,sha256=TtkiD8x7p1ImQUkMJNzJF_7MrrTM0RfDvNS8qu8VccQ,8792
+lusid/models/credit_default_swap.py,sha256=1_4KJc6Uf9bzx-80aCmctchtP3FljZ3gttdwq8YA1kk,10043
 lusid/models/credit_premium_cash_flow_event.py,sha256=iwHmuCR3gdG74eqsT40fc4ShfXYc3--7h4EE6XGddKY,7231
 lusid/models/credit_rating.py,sha256=3EJjCwgdDT04iclq5OTBWughXAbXc9FkOtz-x7i5rks,3088
 lusid/models/credit_spread_curve_data.py,sha256=N2gish4RNEdHNRwo8AceZbY5dPUtKy8Lt1WTRxrDHNw,7174
@@ -399,7 +399,7 @@ lusid/models/equity_curve_by_prices_data.py,sha256=bfvm9uAlWWiI_jhLacOXk-v_IvdyT
 lusid/models/equity_curve_dependency.py,sha256=bXyEO_TzvZtxmi16cFQYZwL9W6qApALe5pIHC4M8jRc,5028
 lusid/models/equity_model_options.py,sha256=taOqGGZiLmchhJRrv8wjvrKPKCh32njkp0DgfwAb7AE,3698
 lusid/models/equity_option.py,sha256=ZAuN7PXXEyQOgxKgy12vwa9iw1VDqa-VsKYm4klTIAE,9922
-lusid/models/equity_swap.py,sha256=7Cx4rwmc_EkIAuF8YODYDBATM17BuCRhL1TeeD2Mgog,9522
+lusid/models/equity_swap.py,sha256=GlpM1bw0FAqpWhi_LaOgOlCdYTpc5DmhOnbOZ840J10,10781
 lusid/models/equity_vol_dependency.py,sha256=GcZrPW9sJS5nKXBjVNjcUKIp4UDeovABErfg6uZXGH0,4909
 lusid/models/equity_vol_surface_data.py,sha256=INLwejaCYkya6fjf_rrG33B_z2FFcgFaIEwWUokfh2Y,5865
 lusid/models/error_detail.py,sha256=XkNJc5yCGsIri9wDciaONqobIbADaU90i5UrI71WM4c,3279
@@ -555,7 +555,7 @@ lusid/models/inflation_fixing_dependency.py,sha256=PKxpTIJcyNIMums66g2qG0p6l6F19
 lusid/models/inflation_index_conventions.py,sha256=I9uG6oCE8M5IHq63DZXvH1fI_5TzMcOnSThnfQW97Y0,4811
 lusid/models/inflation_leg.py,sha256=Hpppt_7SGS725JuLRLywbBmYJz15EO6fzp_I_sSsQ5k,10000
 lusid/models/inflation_linked_bond.py,sha256=3wB-6FJDqvbbfsTCyIanB0ia3_4qCemnNOfSkyccU6s,14009
-lusid/models/inflation_swap.py,sha256=5eWehDLTur9JlVcGs3faPrAa5l5mjD_RTtooBqUEVeQ,7020
+lusid/models/inflation_swap.py,sha256=yNBiPnoFg8tZVhMBF1T9EVif9wAnawHCfzsMOfltUIc,8292
 lusid/models/informational_error_event.py,sha256=Z2WkMeq3PbRRvXT689KuelB3xudBLRz9B5_psEL4ta0,6628
 lusid/models/informational_event.py,sha256=KQDUSidVhEtKyzSPUTkgeYX1CNRCAFtiSLoB1b2eWws,7641
 lusid/models/inline_valuation_request.py,sha256=Qn5CwniPwvIDFzkF2GFubAyFFUkT2I9VK99q4mAHK2w,10449
@@ -589,7 +589,7 @@ lusid/models/instrument_properties.py,sha256=h9V6xOKHuhGwwZta08fUhutktMZFS6JDbuJ
 lusid/models/instrument_resolution_detail.py,sha256=glEyZuZ2H965P3XHNiWNMsP-31v-cKH9fjDSeEJzQbI,4989
 lusid/models/instrument_search_property.py,sha256=yQNCLmODfYEkps4RPRfU30ZM6WMyGCR-oLMyHNhSPh4,2297
 lusid/models/instrument_type.py,sha256=fKBxcVqkJA5KVocOe7yZtBhFUJFht6LtKbgrlSyFOBk,2065
-lusid/models/interest_rate_swap.py,sha256=EjIeDLMB62rX1GrFzKk8Qrg0lO2GL9ED5y2qolr6iAs,9001
+lusid/models/interest_rate_swap.py,sha256=eSnamsyshjo46jgslTx87Cz8KHDgVhktCxTkAl_xfWE,9002
 lusid/models/interest_rate_swaption.py,sha256=u2w04LaM9W74KjaZgiPW_wDdl1A7_nx7iPNOwS8agEY,6420
 lusid/models/intermediate_compliance_step.py,sha256=T6P2hdd-otQCQJMz3avj8_NmTvlI5CVz3Us3VY3ejK0,4461
 lusid/models/intermediate_compliance_step_request.py,sha256=cx9WUvfU_jlcOv3RskTeEyn8_WE72Kvfi1KBaqHF9AE,3859
@@ -1058,7 +1058,7 @@ lusid/models/tender_event.py,sha256=qckP0p8lXS_lM0pKkuKnfyHZEpEtgkaW1Berakx4Tdo,
 lusid/models/term_deposit.py,sha256=idaPCCw1PXdaVCDvrYRGR_Z_nYZM6xgjNLMhkmGNOzg,6837
 lusid/models/term_deposit_interest_event.py,sha256=pAzxLyblEb0TMuuu7oIUM3jXkKmRwIMLqBoB5Zkmaok,7009
 lusid/models/term_deposit_principal_event.py,sha256=qK1-hhoVg8C2fXwbUNeKnHWVPvCGzoi37hPjBKPEGLk,7029
-lusid/models/total_return_swap.py,sha256=x3RBIefY7oiI9MfIK3A2okvuAdeVEk025jp6F5gvIr4,7422
+lusid/models/total_return_swap.py,sha256=hyrhC-Z4jB8Dsv4C-XTX8h589uMvO29Vp06k3C8rEwA,8697
 lusid/models/touch.py,sha256=OECUpEFcCT1kPT5SJIsoNHtR8k2AhEAbDd6P86NcF4s,2726
 lusid/models/trade_ticket.py,sha256=ONpDAdaWs3yfUqMxI7Mq0cYpX0aJkN8XH_9n9rIs5IA,2320
 lusid/models/trade_ticket_type.py,sha256=j7f2bfiA_cxaFtjZpT3Natl4BoaGAaEXF6E0ltEzTWE,706
@@ -1227,6 +1227,6 @@ lusid/models/workspace_update_request.py,sha256=uUXEpX-dJ5UiL9w1wMxIFeovSBiTJ-vi
 lusid/models/yield_curve_data.py,sha256=SbxvdJ4-GWK9kpMdw4Fnxc7_kvIMwgsRsd_31UJn7nw,6330
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=HQT__5LQEMu6_1sLKvYj-DI4FH1DJXBIPYfZCTTyrY4,13431
-lusid_sdk-2.1.582.dist-info/METADATA,sha256=135o4OuVw40CG7OxDJFQI7XAIWI0NcGMP5JaJBV3h_g,209148
-lusid_sdk-2.1.582.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lusid_sdk-2.1.582.dist-info/RECORD,,
+lusid_sdk-2.1.584.dist-info/METADATA,sha256=wsG3tcmmTJ-WYFH2w6_Erb9eAjXxKWppBJqKCAYq64s,209148
+lusid_sdk-2.1.584.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lusid_sdk-2.1.584.dist-info/RECORD,,