lusid-sdk 2.1.149__py3-none-any.whl → 2.1.157__py3-none-any.whl

lusid/__init__.py

@@ -166,6 +166,8 @@ from lusid.models.block_request import BlockRequest
 from lusid.models.block_set_request import BlockSetRequest
 from lusid.models.blocked_order_request import BlockedOrderRequest
 from lusid.models.bond import Bond
+from lusid.models.bond_conversion_entry import BondConversionEntry
+from lusid.models.bond_conversion_schedule import BondConversionSchedule
 from lusid.models.bond_coupon_event import BondCouponEvent
 from lusid.models.bond_default_event import BondDefaultEvent
 from lusid.models.bond_principal_event import BondPrincipalEvent
@@ -1231,6 +1233,8 @@ __all__ = [
     "BlockSetRequest",
     "BlockedOrderRequest",
     "Bond",
+    "BondConversionEntry",
+    "BondConversionSchedule",
     "BondCouponEvent",
     "BondDefaultEvent",
     "BondPrincipalEvent",

lusid/configuration.py

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

lusid/models/__init__.py

@@ -88,6 +88,8 @@ from lusid.models.block_request import BlockRequest
 from lusid.models.block_set_request import BlockSetRequest
 from lusid.models.blocked_order_request import BlockedOrderRequest
 from lusid.models.bond import Bond
+from lusid.models.bond_conversion_entry import BondConversionEntry
+from lusid.models.bond_conversion_schedule import BondConversionSchedule
 from lusid.models.bond_coupon_event import BondCouponEvent
 from lusid.models.bond_default_event import BondDefaultEvent
 from lusid.models.bond_principal_event import BondPrincipalEvent
@@ -1076,6 +1078,8 @@ __all__ = [
     "BlockSetRequest",
     "BlockedOrderRequest",
     "Bond",
+    "BondConversionEntry",
+    "BondConversionSchedule",
     "BondCouponEvent",
     "BondDefaultEvent",
     "BondPrincipalEvent",

lusid/models/bond_conversion_entry.py

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Any, Dict, Optional, Union
+from pydantic.v1 import BaseModel, Field, StrictFloat, StrictInt
+
+class BondConversionEntry(BaseModel):
+    """
+    Information required to specify a conversion event for a convertible bond.  # noqa: E501
+    """
+    var_date: Optional[datetime] = Field(None, alias="date", description="The date at which the bond can be converted")
+    denomination: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The number of shares to be issued on conversion will be equal to the denomination of the  bond divided by the conversion price.  Two (and only two) entries out of (Price, Ratio, Denomination) must be provided.  So, to allow one entry out of the three to not be provided, we make all the three  nullable defaulting to zero and during validation we check if there is exactly one  of the three equal to zero.")
+    price: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The conversion price  Two (and only two) entries out of (Price, Ratio, Denomination) must be provided.  So, to allow one entry out of the three to not be provided, we make all the three  nullable defaulting to zero and during validation we check if there is exactly one  of the three equal to zero.")
+    ratio: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="The number of common shares received at the time of conversion for each convertible bond  Two (and only two) entries out of (Price, Ratio, Denomination) must be provided.  So, to allow one entry out of the three to not be provided, we make all the three  nullable defaulting to zero and during validation we check if there is exactly one  of the three equal to zero.")
+    __properties = ["date", "denomination", "price", "ratio"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> BondConversionEntry:
+        """Create an instance of BondConversionEntry from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BondConversionEntry:
+        """Create an instance of BondConversionEntry from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BondConversionEntry.parse_obj(obj)
+
+        _obj = BondConversionEntry.parse_obj({
+            "var_date": obj.get("date"),
+            "denomination": obj.get("denomination"),
+            "price": obj.get("price"),
+            "ratio": obj.get("ratio")
+        })
+        return _obj

lusid/models/bond_conversion_schedule.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from pydantic.v1 import Field, StrictBool, StrictStr, conlist, constr, validator
+from lusid.models.bond_conversion_entry import BondConversionEntry
+from lusid.models.schedule import Schedule
+
+class BondConversionSchedule(Schedule):
+    """
+    A BondConversionSchedule object represents a class containing the  information required for the creation of convertible features in a ComplexBond  # noqa: E501
+    """
+    identifiers: Optional[Dict[str, StrictStr]] = Field(None, description="The market identifier(s) of the share that the bond converts to. The instrument  will not fail validation if no identifier is supplied.")
+    bond_conversion_entries: Optional[conlist(BondConversionEntry)] = Field(None, alias="bondConversionEntries", description="The dates at which the bond may be converted and associated information required about the conversion.")
+    conversion_trigger: constr(strict=True, max_length=50, min_length=0) = Field(..., alias="conversionTrigger", description="Corporate event that triggers a conversion    Supported string (enumeration) values are: [NextEquityFinancing, IpoConversion, KnownDates, SoftCall].")
+    delivery_type: Optional[constr(strict=True, max_length=50, min_length=0)] = Field(None, alias="deliveryType", description="Is a conversion made into cash or into shares?    Supported string (enumeration) values are: [Cash, Physical].")
+    exercise_type: constr(strict=True, max_length=50, min_length=0) = Field(..., alias="exerciseType", description="The exercise type of the conversion schedule (American or European).  For American type, the bond is convertible from a given exercise date until the next date in the schedule, or until it matures.  For European type, the bond is only convertible on the given exercise date.    Supported string (enumeration) values are: [European, Bermudan, American].")
+    includes_accrued: Optional[StrictBool] = Field(None, alias="includesAccrued", description="Set this to true if a accrued interest is included in the conversion. Defaults to true.")
+    mandatory_conversion: Optional[StrictBool] = Field(None, alias="mandatoryConversion", description="Set this to true if a conversion is mandatory if the trigger occurs. Defaults to false.")
+    notification_period_end: Optional[datetime] = Field(None, alias="notificationPeriodEnd", description="The last day in the notification period for the conversion of the bond")
+    notification_period_start: Optional[datetime] = Field(None, alias="notificationPeriodStart", description="The first day in the notification period for the conversion of the bond")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
+    additional_properties: Dict[str, Any] = {}
+    __properties = ["scheduleType", "identifiers", "bondConversionEntries", "conversionTrigger", "deliveryType", "exerciseType", "includesAccrued", "mandatoryConversion", "notificationPeriodEnd", "notificationPeriodStart"]
+
+    @validator('schedule_type')
+    def schedule_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> BondConversionSchedule:
+        """Create an instance of BondConversionSchedule from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                            "additional_properties"
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each item in bond_conversion_entries (list)
+        _items = []
+        if self.bond_conversion_entries:
+            for _item in self.bond_conversion_entries:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['bondConversionEntries'] = _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 identifiers (nullable) is None
+        # and __fields_set__ contains the field
+        if self.identifiers is None and "identifiers" in self.__fields_set__:
+            _dict['identifiers'] = None
+
+        # set to None if bond_conversion_entries (nullable) is None
+        # and __fields_set__ contains the field
+        if self.bond_conversion_entries is None and "bond_conversion_entries" in self.__fields_set__:
+            _dict['bondConversionEntries'] = None
+
+        # set to None if delivery_type (nullable) is None
+        # and __fields_set__ contains the field
+        if self.delivery_type is None and "delivery_type" in self.__fields_set__:
+            _dict['deliveryType'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> BondConversionSchedule:
+        """Create an instance of BondConversionSchedule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return BondConversionSchedule.parse_obj(obj)
+
+        _obj = BondConversionSchedule.parse_obj({
+            "schedule_type": obj.get("scheduleType"),
+            "identifiers": obj.get("identifiers"),
+            "bond_conversion_entries": [BondConversionEntry.from_dict(_item) for _item in obj.get("bondConversionEntries")] if obj.get("bondConversionEntries") is not None else None,
+            "conversion_trigger": obj.get("conversionTrigger"),
+            "delivery_type": obj.get("deliveryType"),
+            "exercise_type": obj.get("exerciseType"),
+            "includes_accrued": obj.get("includesAccrued"),
+            "mandatory_conversion": obj.get("mandatoryConversion"),
+            "notification_period_end": obj.get("notificationPeriodEnd"),
+            "notification_period_start": obj.get("notificationPeriodStart")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj

lusid/models/fixed_schedule.py

@@ -39,15 +39,15 @@ class FixedSchedule(Schedule):
     payment_currency: StrictStr = Field(..., alias="paymentCurrency", description="Payment currency. This does not have to be the same as the nominal bond or observation/reset currency.")
     stub_type: Optional[StrictStr] = Field(None, alias="stubType", description="StubType required of the schedule    Supported string (enumeration) values are: [ShortFront, ShortBack, LongBack, LongFront, Both].")
     ex_dividend_configuration: Optional[ExDividendConfiguration] = Field(None, alias="exDividendConfiguration")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "startDate", "maturityDate", "flowConventions", "couponRate", "conventionName", "exDividendDays", "notional", "paymentCurrency", "stubType", "exDividendConfiguration"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

lusid/models/float_schedule.py

@@ -45,15 +45,15 @@ class FloatSchedule(Schedule):
     ex_dividend_configuration: Optional[ExDividendConfiguration] = Field(None, alias="exDividendConfiguration")
     compounding: Optional[Compounding] = None
     reset_convention: Optional[constr(strict=True, max_length=16, min_length=0)] = Field(None, alias="resetConvention", description="Control how resets are generated relative to payment convention(s).    Supported string (enumeration) values are: [InAdvance, InArrears].")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "startDate", "maturityDate", "flowConventions", "conventionName", "exDividendDays", "indexConventionName", "indexConventions", "notional", "paymentCurrency", "spread", "stubType", "exDividendConfiguration", "compounding", "resetConvention"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

lusid/models/fx_linked_notional_schedule.py

@@ -32,15 +32,15 @@ class FxLinkedNotionalSchedule(Schedule):
     varying_notional_currency: StrictStr = Field(..., alias="varyingNotionalCurrency", description="The currency of the varying notional amount.")
     varying_notional_fixing_dates: RelativeDateOffset = Field(..., alias="varyingNotionalFixingDates")
     varying_notional_interim_exchange_payment_dates: Optional[RelativeDateOffset] = Field(None, alias="varyingNotionalInterimExchangePaymentDates")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "fxConventions", "varyingNotionalCurrency", "varyingNotionalFixingDates", "varyingNotionalInterimExchangePaymentDates"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

lusid/models/fx_rate_schedule.py

@@ -31,15 +31,15 @@ class FxRateSchedule(Schedule):
     fx_conversion_types: Optional[conlist(StrictStr)] = Field(None, alias="fxConversionTypes", description="List of flags to indicate if coupon payments, principal payments or both are converted")
     rate: Optional[Union[StrictFloat, StrictInt]] = Field(None, description="FxRate used to convert payments. Assumed to be in units of the ToCurrency so conversion is paymentAmount x fxRate")
     to_currency: Optional[StrictStr] = Field(None, alias="toCurrency", description="Currency that payments are converted to")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "flowConventions", "fxConversionTypes", "rate", "toCurrency"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

lusid/models/optionality_schedule.py

@@ -30,15 +30,15 @@ class OptionalitySchedule(Schedule):
     exercise_type: Optional[StrictStr] = Field(None, alias="exerciseType", description="The exercise type of the optionality schedule (American or European).  For American type, the bond is perpetually callable from a given exercise date until it matures, or the next date in the schedule.  For European type, the bond is only callable on a given exercise date.    Supported string (enumeration) values are: [European, American].")
     option_entries: Optional[conlist(OptionEntry)] = Field(None, alias="optionEntries", description="The dates at which the bond call/put may be actioned, and associated strikes.")
     option_type: Optional[StrictStr] = Field(None, alias="optionType", description="Type of optionality for the schedule.    Supported string (enumeration) values are: [Call, Put].")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "exerciseType", "optionEntries", "optionType"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

lusid/models/schedule.py

@@ -26,14 +26,14 @@ class Schedule(BaseModel):
     """
     Base class for representing schedules in LUSID.  This base class should not be directly instantiated; each supported ScheduleType has a corresponding inherited class.  # noqa: E501
     """
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     __properties = ["scheduleType"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:
@@ -46,6 +46,7 @@ class Schedule(BaseModel):
 
     # discriminator mappings
     __discriminator_value_class_map = {
+        'BondConversionSchedule': 'BondConversionSchedule',
         'FixedSchedule': 'FixedSchedule',
         'FloatSchedule': 'FloatSchedule',
         'FxLinkedNotionalSchedule': 'FxLinkedNotionalSchedule',
@@ -72,7 +73,7 @@ class Schedule(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Union(FixedSchedule, FloatSchedule, FxLinkedNotionalSchedule, FxRateSchedule, OptionalitySchedule, StepSchedule):
+    def from_json(cls, json_str: str) -> Union(BondConversionSchedule, FixedSchedule, FloatSchedule, FxLinkedNotionalSchedule, FxRateSchedule, OptionalitySchedule, StepSchedule):
         """Create an instance of Schedule from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -85,7 +86,7 @@ class Schedule(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> Union(FixedSchedule, FloatSchedule, FxLinkedNotionalSchedule, FxRateSchedule, OptionalitySchedule, StepSchedule):
+    def from_dict(cls, obj: dict) -> Union(BondConversionSchedule, FixedSchedule, FloatSchedule, FxLinkedNotionalSchedule, FxRateSchedule, OptionalitySchedule, StepSchedule):
         """Create an instance of Schedule from a dict"""
         # look up the object type based on discriminator mapping
         object_type = cls.get_discriminator_value(obj)

lusid/models/schedule_type.py

@@ -36,6 +36,7 @@ class ScheduleType(str, Enum):
     EXERCISE = 'Exercise'
     FXRATESCHEDULE = 'FxRateSchedule'
     FXLINKEDNOTIONALSCHEDULE = 'FxLinkedNotionalSchedule'
+    BONDCONVERSIONSCHEDULE = 'BondConversionSchedule'
     INVALID = 'Invalid'
 
     @classmethod

lusid/models/step_schedule.py

@@ -30,15 +30,15 @@ class StepSchedule(Schedule):
     level_type: constr(strict=True, min_length=1) = Field(..., alias="levelType", description="The type of shift or adjustment that the quantity represents.    Supported string (enumeration) values are: [Absolute, AbsoluteShift, Percentage, AbsolutePercentage].")
     step_schedule_type: constr(strict=True, min_length=1) = Field(..., alias="stepScheduleType", description="The type of step that this schedule is for.  Supported string (enumeration) values are: [Coupon, Notional, Spread].")
     steps: conlist(LevelStep) = Field(..., description="The level steps which are applied.")
-    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, Invalid")
+    schedule_type: StrictStr = Field(..., alias="scheduleType", description="The available values are: FixedSchedule, FloatSchedule, OptionalitySchedule, StepSchedule, Exercise, FxRateSchedule, FxLinkedNotionalSchedule, BondConversionSchedule, Invalid")
     additional_properties: Dict[str, Any] = {}
     __properties = ["scheduleType", "levelType", "stepScheduleType", "steps"]
 
     @validator('schedule_type')
     def schedule_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid'):
-            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'Invalid')")
+        if value not in ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid'):
+            raise ValueError("must be one of enum values ('FixedSchedule', 'FloatSchedule', 'OptionalitySchedule', 'StepSchedule', 'Exercise', 'FxRateSchedule', 'FxLinkedNotionalSchedule', 'BondConversionSchedule', 'Invalid')")
         return value
 
     class Config:

{lusid_sdk-2.1.149.dist-info → lusid_sdk-2.1.157.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lusid-sdk
-Version: 2.1.149
+Version: 2.1.157
 Summary: LUSID API
 Home-page: https://github.com/finbourne/lusid-sdk-python
 License: MIT
@@ -29,8 +29,8 @@ FINBOURNE Technology
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.11.6583
-- Package version: 2.1.149
+- API version: 0.11.6591
+- Package version: 2.1.157
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.finbourne.com](https://www.finbourne.com)
 
@@ -818,6 +818,8 @@ Class | Method | HTTP request | Description
  - [BlockSetRequest](docs/BlockSetRequest.md)
  - [BlockedOrderRequest](docs/BlockedOrderRequest.md)
  - [Bond](docs/Bond.md)
+ - [BondConversionEntry](docs/BondConversionEntry.md)
+ - [BondConversionSchedule](docs/BondConversionSchedule.md)
  - [BondCouponEvent](docs/BondCouponEvent.md)
  - [BondDefaultEvent](docs/BondDefaultEvent.md)
  - [BondPrincipalEvent](docs/BondPrincipalEvent.md)

{lusid_sdk-2.1.149.dist-info → lusid_sdk-2.1.157.dist-info}/RECORD

@@ -1,4 +1,4 @@
-lusid/__init__.py,sha256=91W_dgAwSilELVYA5PulvTRVIaEOtJ68MsxJvP9XtDM,109701
+lusid/__init__.py,sha256=ofvK1WGq1Kn4FR1YuETjMikgAENOxKQNjLE3oIJzvGw,109898
 lusid/api/__init__.py,sha256=PFpT-ADthWd08-JqKOqQTbVW6cz9wdP_us6bg3aBFfs,5555
 lusid/api/abor_api.py,sha256=AvgsHuWE7qRSYJhKveBE2htSjHpqqS0VNJrysAfwME0,159655
 lusid/api/abor_configuration_api.py,sha256=G2bKPtMYOZ2GhUrg-nPJtCa9XIZdZYK7oafcbJWDMP8,64033
@@ -67,7 +67,7 @@ lusid/api/transaction_portfolios_api.py,sha256=7G5m6iTQXTKCc6ASdxnlVJjvFascHxEgD
 lusid/api/translation_api.py,sha256=xTAaKEW96JTDIZBXCjxSguCa7Gz4oVd5jdObUE2egwo,20092
 lusid/api_client.py,sha256=dF6l9RAsdxdQjf6Qn4ny6LB-QXlJmsscWiozCvyyBFA,30709
 lusid/api_response.py,sha256=6-gnhty6lu8MMAERt3_kTVD7UxQgWFfcjgpcq6iN5IU,855
-lusid/configuration.py,sha256=jaHSqTuHb3XadaK-8v3unyCGOAYvhgcaJtegp5GmlxE,14404
+lusid/configuration.py,sha256=vxELEI5WHiPmGWopiiJS5VIVh4axdbJlmXALNnSscfc,14404
 lusid/exceptions.py,sha256=HIQwgmQrszLlcVCLaqex8dO0laVuejUyOMz7U2ZWJ6s,5326
 lusid/extensions/__init__.py,sha256=L7EF4zKjcq1g2GodEumg1-C9xKs7YrQ0QHGPi8XbpO4,629
 lusid/extensions/api_client.py,sha256=Ob06urm4Em3MLzgP_geyeeGsPCkU225msW_1kpIeABM,30567
@@ -81,7 +81,7 @@ lusid/extensions/rest.py,sha256=tjVCu-cRrYcjp-ttB975vebPKtBNyBWaeoAdO3QXG2I,1269
 lusid/extensions/retry.py,sha256=orBJ1uF1iT1IncjWX1iGHVqsCgTh0SBe9rtiV_sPnwk,11564
 lusid/extensions/socket_keep_alive.py,sha256=NGlqsv-E25IjJOLGZhXZY6kUdx51nEF8qCQyVdzayRk,1653
 lusid/extensions/tcp_keep_alive_connector.py,sha256=zaGtUsygRsxB1_4B3x39K3ILwztdhMLDv5bFZV7zmGE,3877
-lusid/models/__init__.py,sha256=pNw66Pm9H9yBbmateMudSFJdjpaT1kM_2Sr7rLBujlM,103114
+lusid/models/__init__.py,sha256=cDBsWUZgZIEOmeYLRzRTT_shkNWF0lGHibVnJKqrq-w,103311
 lusid/models/a2_b_breakdown.py,sha256=Txi12EIQw3mH6NM-25QkOnHSQc3BVAWrP7yl9bZswSY,2947
 lusid/models/a2_b_category.py,sha256=k6NPAACi0CUjKyhdQac4obQSrPmp2PXD6lkAtCnyEFM,2725
 lusid/models/a2_b_data_record.py,sha256=zKGS2P4fzNpzdcGJiSIpkY4P3d_jAcawYfyuPCDeQgk,9737
@@ -156,6 +156,8 @@ lusid/models/block_request.py,sha256=oSYaZNOUZF4WGV-NhlyEkBu9eKQpnni5ATa_sjGMw5A
 lusid/models/block_set_request.py,sha256=rf_hhzmOX2F57W1yino-nh4YZ8NGSWiaJxeCLwOL9UI,2620
 lusid/models/blocked_order_request.py,sha256=K8u2BlSw00h5xKcyKrHvA48hesX8WW9x27x_ckzs-wI,5839
 lusid/models/bond.py,sha256=uJZue_Xf8zoEgklJfnRxJRM8c-NzLTEEI19oClJct3I,12280
+lusid/models/bond_conversion_entry.py,sha256=DFS635pxCi5hsrfOfOxH6gWlAzUDD9D7u75NPCLZF6Q,3549
+lusid/models/bond_conversion_schedule.py,sha256=ETxUYhDRyycn_LyLd2P8dT0bHS-Z1XrCYIQdc-vWm8k,7658
 lusid/models/bond_coupon_event.py,sha256=97q-bjCGfyKZG__qmaBNkXwIfS60zT47hFa5mhgjMfs,5249
 lusid/models/bond_default_event.py,sha256=by5lnvQh_RlQR0x7rhEriW_Q95glta5YATvBbUwUBPI,4727
 lusid/models/bond_principal_event.py,sha256=ygwCneWG8YmnNQEZZGnA8wxoY3cNduV31kXVq2XUvXc,5284
@@ -391,9 +393,9 @@ lusid/models/filter_step.py,sha256=59GcsBp_Y7D3MXN-_kZKRXcBYw9ZRDXMlH1Qm_TOj4g,3
 lusid/models/filter_step_request.py,sha256=uhDwkG1IrJdb5fUZIoJ6H95U-TVlpYXo7XRyspvk2Js,3360
 lusid/models/fixed_leg.py,sha256=HkKftiIQHb0f3pGE8ItI6Ep3EQTVnZ-WRAYGLmCjBfw,6618
 lusid/models/fixed_leg_all_of_overrides.py,sha256=JR8DwX7y3sO5i6vBEJHdBmaaJKQqLSAQd7AoMzp21Q0,2879
-lusid/models/fixed_schedule.py,sha256=GWEPNZF2aN7RNmGeOc-MDPcnynvo16RzQMPtgw0VCAg,7174
+lusid/models/fixed_schedule.py,sha256=pTpKwncvp16eSrscuuTHli1W9L3hsuY1MHShcIqAh_k,7250
 lusid/models/flexible_loan.py,sha256=08jrLqECPsSfowr987Y5zy6zF0d7aTqIP-bCGnfB6WM,6252
-lusid/models/float_schedule.py,sha256=yvLpNB5bMFAbtgWEwOdHDaqbEFc97kMmdiur9ygV164,9196
+lusid/models/float_schedule.py,sha256=inv9F0Y0owOfCv93NKs40-h5c7jdifauwh0ZQPxZ6xA,9272
 lusid/models/floating_leg.py,sha256=Q2W2Xk_j0Bh4jVDVigHK9i8DpudCtpkdW_AS8WiAAbI,7558
 lusid/models/flow_convention_name.py,sha256=HFTshKIRBvjLdmcd8FzM-6Jb6-dlq-yTOwjCw0p2ZME,2813
 lusid/models/flow_conventions.py,sha256=OJBFQ28_-Wp5VCQ_CXwLksvz--6kysJh3zUF8xM8ORE,10512
@@ -418,9 +420,9 @@ lusid/models/fx_forward_settlement_event.py,sha256=m0cmCjC6PQvIGpPJ2IlSdUAEzGXXJ
 lusid/models/fx_forward_tenor_curve_data.py,sha256=S1kHnkg2Fpds9xDXzjLxBoUXGb70uDsEBg0zkNxfs1Q,7547
 lusid/models/fx_forward_tenor_pips_curve_data.py,sha256=S8fQm_x1CiHXAQAMs4Pp7bczo7DWfUpRTzbhbs-r-zw,7645
 lusid/models/fx_forwards_dependency.py,sha256=0ziw4k_SX5hMqWJdZ0pYxRVL2xWD7d0hLgFOHQqosR0,5238
-lusid/models/fx_linked_notional_schedule.py,sha256=n7LIEIfIiCu3hxvsQ7O6JVIlAKJK2jD72My2k4poukI,5408
+lusid/models/fx_linked_notional_schedule.py,sha256=R5uAwhjQ3FGSeV4UIsP49FEV0SwWjPXs9HEAlX9eLCc,5484
 lusid/models/fx_option.py,sha256=grXe2UQptStegP3kfhv0RVHsPVtMOgk7E6cKAJCc8NQ,11849
-lusid/models/fx_rate_schedule.py,sha256=CzwGlFM_cHg5pvmEFFVkfOoVmWhZO02mcuzapjZTfco,5183
+lusid/models/fx_rate_schedule.py,sha256=uFIPAVyiyRSzF9MG2pbusqd6XXn7QrO29KyyyEUhY5Y,5259
 lusid/models/fx_swap.py,sha256=qMrqswj-rnljtRJvpEnyfbFFRTfouZOHBDYFtfrx6ow,6948
 lusid/models/fx_tenor_convention.py,sha256=KF4ZmP8U8FtVpAjUa6zI57qldYiFCs-5SMiimU70ddY,2456
 lusid/models/fx_vol_dependency.py,sha256=mCRJuSff0O7tKRB6pfL60xbeRS7f9lzWx6CHVd2xnco,4948
@@ -565,7 +567,7 @@ lusid/models/operation.py,sha256=LtqUFww2hQy0sa9kdCpHPz3XSvtHxqsWtRKjRDku2TA,251
 lusid/models/operation_type.py,sha256=kUOhDAUWv4sYAaZwRlXwaowlr_jBw9uUmsW1ffRsMv8,644
 lusid/models/operator.py,sha256=pET4TePqHQQxhblcnIQjtda3Y7a5H864MUFMJBE4loE,797
 lusid/models/option_entry.py,sha256=KJfFze7xIJxeIJ7hXxJhkUydFhg9KJU4rIAfLdBaT8k,2136
-lusid/models/optionality_schedule.py,sha256=8K9u_8rPLkkAr9HwGi62hsiVwH-4VeZQijfAnjxAMZg,5425
+lusid/models/optionality_schedule.py,sha256=lZh9nWhUmmkcfzAjsM8qvTAtXf4Fm97vhIbqD-EIboU,5501
 lusid/models/order.py,sha256=-47dm6-P-pNB--pBRn6UxGCv7Az7ECBAgoykBdR3agM,9659
 lusid/models/order_by_spec.py,sha256=9RyLPdTBImMEcjhN2mq-BtMykndyNLZSpJ3xO_biaZk,2319
 lusid/models/order_flow_configuration.py,sha256=2Hkp1PwSVqdfawZq07A_nIoPqH-41yEhC_6aIvk3e98,1979
@@ -865,8 +867,8 @@ lusid/models/rounding_configuration_component.py,sha256=bLKRyNkrImXApHRSxODZ0Kp6
 lusid/models/rounding_convention.py,sha256=wHP76MnZGN_2m25x7fRsNA6mkcCLmkHx-YSGSRRnrzk,3968
 lusid/models/rules_interval.py,sha256=1lObUnebloPZiC_7G3vEhvjmBElwhnyp_QrIH5hVRTA,2786
 lusid/models/scaling_methodology.py,sha256=rP8s-CkaG3rZGG9E9MxCJu3NzbKKool_r_fB-DxMlg0,699
-lusid/models/schedule.py,sha256=MVaZMITw7n7WrJYHlZ0UDSi89ypQ-MDpxcuPnpzapYo,4032
-lusid/models/schedule_type.py,sha256=uhuSEg1BNpgNkbKtUEK8FLs_Tf0TeotY6fStjQNxMto,901
+lusid/models/schedule.py,sha256=IQeymxyyU0fHANXmPICy6vUQ2sDC9KoyUk9U_X23wTU,4216
+lusid/models/schedule_type.py,sha256=hdAqhI4A6L1z-Ipwd2xaecMiTCFqRN1Bz1Lc2BWXZTg,955
 lusid/models/scope_definition.py,sha256=IUTgJoHwDqVhCWfnyGurk0zIhKN_C7JoltgIRvcSLVc,1907
 lusid/models/scrip_dividend_event.py,sha256=UeHCkzvWUY8vsfWkAaiE6xLsaomfdmMuTHvk5sFp8gI,6273
 lusid/models/script_map_reference.py,sha256=lAT1UWlV1KaP5i4mTJFZDrm3Uw8HdxyvpA2ozl7lqFU,3357
@@ -902,7 +904,7 @@ lusid/models/staging_rule.py,sha256=RxvQoGTR8tShrGw4MLFhaR5L4kxdjeXK8hCGp0kagsk,
 lusid/models/staging_rule_approval_criteria.py,sha256=qmAPg2CfdCQvgSiSLte1n9PAz0fYipc8oDVb2QaMIxk,2687
 lusid/models/staging_rule_match_criteria.py,sha256=_RxCyvulK3necsQz6LI7YacbSZAktEN5cITthxm9F-w,3561
 lusid/models/staging_rule_set.py,sha256=05h5vV_9s3V2MYoH7o1K8pmjlUq15jJSsmyJ5ObRyKs,4896
-lusid/models/step_schedule.py,sha256=uNakrJcB9X3e31PekjEBbu_MLbKr77P-57Qf1Ot3uPg,4504
+lusid/models/step_schedule.py,sha256=1xCC_C_GzTIOY8GPUIaF75YoieJ6fwV4qQFQHTsJypg,4580
 lusid/models/stock_dividend_event.py,sha256=3yp3JNGjMtnd4g9t3Ilig_K75Weh9U5ZZVDC8jPZ5ic,6311
 lusid/models/stock_split_event.py,sha256=-KLO1YPa4wfT-dafdoRjHGP7yqBioxsu5SVev1kW6qQ,6255
 lusid/models/stream.py,sha256=TGFloyewF3hi9RLyg0K3z13zxgvqAlHt46_AJuP9l7E,2865
@@ -1069,6 +1071,6 @@ lusid/models/weighted_instruments.py,sha256=1y_y_vw4-LPsbkQx4FOzWdZc5fJnzhVkf1D3
 lusid/models/yield_curve_data.py,sha256=SbxvdJ4-GWK9kpMdw4Fnxc7_kvIMwgsRsd_31UJn7nw,6330
 lusid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lusid/rest.py,sha256=TNUzQ3yLNT2L053EdR7R0vNzQh2J3TlYD1T56Dye0W0,10138
-lusid_sdk-2.1.149.dist-info/METADATA,sha256=wPY55Y_ZGDtM_OjuVLAMj8cQnipqs0jfG7m1oihleso,187686
-lusid_sdk-2.1.149.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lusid_sdk-2.1.149.dist-info/RECORD,,
+lusid_sdk-2.1.157.dist-info/METADATA,sha256=LiHhXDcgkbr9qUuBHYDGalli54rRrYvVA08TKdgouYA,187800
+lusid_sdk-2.1.157.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lusid_sdk-2.1.157.dist-info/RECORD,,