lusid-sdk 2.1.261__py3-none-any.whl → 2.1.292__py3-none-any.whl

lusid/models/quote_series_id.py

@@ -28,17 +28,14 @@ class QuoteSeriesId(BaseModel):
     provider: constr(strict=True, min_length=1) = Field(..., description="The platform or vendor that provided the quote. The available values are: Client, DataScope, Lusid, Edi, TraderMade, FactSet, SIX, Bloomberg, Rimes, ICE")
     price_source: Optional[StrictStr] = Field(None, alias="priceSource", description="The source or originator of the quote, e.g. a bank or financial institution.")
     instrument_id: constr(strict=True, min_length=1) = Field(..., alias="instrumentId", description="The value of the instrument identifier that uniquely identifies the instrument that the quote is for, e.g. 'BBG00JX0P539'.")
-    instrument_id_type: Optional[StrictStr] = Field(..., alias="instrumentIdType", description="The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip")
-    quote_type: Optional[StrictStr] = Field(..., alias="quoteType", description="The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice")
+    instrument_id_type: StrictStr = Field(..., alias="instrumentIdType", description="The type of instrument identifier used to uniquely identify the instrument that the quote is for, e.g. 'Figi'. The available values are: LusidInstrumentId, Figi, RIC, QuotePermId, Isin, CurrencyPair, ClientInternal, Sedol, Cusip")
+    quote_type: StrictStr = Field(..., alias="quoteType", description="The type of the quote. This allows for quotes other than prices e.g. rates or spreads to be used. The available values are: Price, Spread, Rate, LogNormalVol, NormalVol, ParSpread, IsdaSpread, Upfront, Index, Ratio, Delta, PoolFactor, InflationAssumption, DirtyPrice, PrincipalWriteOff, InterestDeferred, InterestShortfall")
     field: constr(strict=True, min_length=1) = Field(..., description="The field of the quote e.g. bid, mid, ask etc. This should be consistent across a time series of quotes. The allowed values depend on the provider according to the following rules: Client : *Any value is accepted*; DataScope : 'bid', 'mid', 'ask'; Lusid : *Any value is accepted*; Edi : 'bid', 'mid', 'ask', 'open', 'close', 'last'; TraderMade : 'bid', 'mid', 'ask', 'open', 'close', 'high', 'low'; FactSet : 'bid', 'mid', 'ask', 'open', 'close'; SIX : 'bid', 'mid', 'ask', 'open', 'close', 'last', 'referencePrice', 'highPrice', 'lowPrice', 'maxRedemptionPrice', 'maxSubscriptionPrice', 'openPrice', 'bestBidPrice', 'lastBidPrice', 'bestAskPrice', 'lastAskPrice'; Bloomberg : 'bid', 'mid', 'ask', 'open', 'close', 'last'; Rimes : 'bid', 'mid', 'ask', 'open', 'close', 'last'; ICE : 'ask', 'bid'")
     __properties = ["provider", "priceSource", "instrumentId", "instrumentIdType", "quoteType", "field"]
 
     @validator('instrument_id_type')
     def instrument_id_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
         if value not in ('LusidInstrumentId', 'Figi', 'RIC', 'QuotePermId', 'Isin', 'CurrencyPair', 'ClientInternal', 'Sedol', 'Cusip'):
             raise ValueError("must be one of enum values ('LusidInstrumentId', 'Figi', 'RIC', 'QuotePermId', 'Isin', 'CurrencyPair', 'ClientInternal', 'Sedol', 'Cusip')")
         return value
@@ -46,11 +43,8 @@ class QuoteSeriesId(BaseModel):
     @validator('quote_type')
     def quote_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice'):
-            raise ValueError("must be one of enum values ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice')")
+        if value not in ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice', 'PrincipalWriteOff', 'InterestDeferred', 'InterestShortfall'):
+            raise ValueError("must be one of enum values ('Price', 'Spread', 'Rate', 'LogNormalVol', 'NormalVol', 'ParSpread', 'IsdaSpread', 'Upfront', 'Index', 'Ratio', 'Delta', 'PoolFactor', 'InflationAssumption', 'DirtyPrice', 'PrincipalWriteOff', 'InterestDeferred', 'InterestShortfall')")
         return value
 
     class Config:
@@ -82,16 +76,6 @@ class QuoteSeriesId(BaseModel):
         if self.price_source is None and "price_source" in self.__fields_set__:
             _dict['priceSource'] = None
 
-        # set to None if instrument_id_type (nullable) is None
-        # and __fields_set__ contains the field
-        if self.instrument_id_type is None and "instrument_id_type" in self.__fields_set__:
-            _dict['instrumentIdType'] = None
-
-        # set to None if quote_type (nullable) is None
-        # and __fields_set__ contains the field
-        if self.quote_type is None and "quote_type" in self.__fields_set__:
-            _dict['quoteType'] = None
-
         return _dict
 
     @classmethod

lusid/models/quote_type.py

@@ -43,6 +43,9 @@ class QuoteType(str, Enum):
     POOLFACTOR = 'PoolFactor'
     INFLATIONASSUMPTION = 'InflationAssumption'
     DIRTYPRICE = 'DirtyPrice'
+    PRINCIPALWRITEOFF = 'PrincipalWriteOff'
+    INTERESTDEFERRED = 'InterestDeferred'
+    INTERESTSHORTFALL = 'InterestShortfall'
 
     @classmethod
     def from_json(cls, json_str: str) -> QuoteType:

lusid/models/share_class_amount.py

@@ -0,0 +1,73 @@
+# 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 typing import Any, Dict, Optional
+from pydantic.v1 import BaseModel
+from lusid.models.multi_currency_amounts import MultiCurrencyAmounts
+
+class ShareClassAmount(BaseModel):
+    """
+    ShareClassAmount
+    """
+    value: Optional[MultiCurrencyAmounts] = None
+    __properties = ["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) -> ShareClassAmount:
+        """Create an instance of ShareClassAmount from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of value
+        if self.value:
+            _dict['value'] = self.value.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ShareClassAmount:
+        """Create an instance of ShareClassAmount from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ShareClassAmount.parse_obj(obj)
+
+        _obj = ShareClassAmount.parse_obj({
+            "value": MultiCurrencyAmounts.from_dict(obj.get("value")) if obj.get("value") is not None else None
+        })
+        return _obj

lusid/models/share_class_breakdown.py

@@ -0,0 +1,171 @@
+# 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 typing import Any, Dict, Optional, Union
+from pydantic.v1 import BaseModel, Field, StrictFloat, StrictInt
+from lusid.models.fee_accrual import FeeAccrual
+from lusid.models.multi_currency_amounts import MultiCurrencyAmounts
+from lusid.models.previous_share_class_breakdown import PreviousShareClassBreakdown
+from lusid.models.share_class_amount import ShareClassAmount
+from lusid.models.unitisation_data import UnitisationData
+
+class ShareClassBreakdown(BaseModel):
+    """
+    The Valuation Point Data for a Share Class on a specified date.  # noqa: E501
+    """
+    back_out: Dict[str, ShareClassAmount] = Field(..., alias="backOut", description="Bucket of detail for the Valuation Point where data points have been 'backed out'.")
+    dealing: Dict[str, ShareClassAmount] = Field(..., description="Bucket of detail for any 'Dealing' that has occured inside the queried period.")
+    pn_l: Dict[str, ShareClassAmount] = Field(..., alias="pnL", description="Bucket of detail for 'PnL' that has occured inside the queried period.")
+    gav: MultiCurrencyAmounts = Field(...)
+    fees: Dict[str, FeeAccrual] = Field(..., description="Bucket of detail for any 'Fees' that have been charged in the selected period.")
+    nav: MultiCurrencyAmounts = Field(...)
+    unitisation: Optional[UnitisationData] = None
+    miscellaneous: Optional[Dict[str, ShareClassAmount]] = Field(None, description="Not used directly by the LUSID engines but serves as a holding area for any custom derived data points that may be useful in, for example, fee calculations).")
+    share_class_to_fund_fx_rate: Union[StrictFloat, StrictInt] = Field(..., alias="shareClassToFundFxRate", description="The fx rate from the Share Class currency to the fund currency at this valuation point.")
+    capital_ratio: Union[StrictFloat, StrictInt] = Field(..., alias="capitalRatio", description="The proportion of the fund's adjusted beginning equity (ie: the sum of the previous NAV and the net dealing) that is invested in the share class.")
+    previous_share_class_breakdown: PreviousShareClassBreakdown = Field(..., alias="previousShareClassBreakdown")
+    __properties = ["backOut", "dealing", "pnL", "gav", "fees", "nav", "unitisation", "miscellaneous", "shareClassToFundFxRate", "capitalRatio", "previousShareClassBreakdown"]
+
+    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) -> ShareClassBreakdown:
+        """Create an instance of ShareClassBreakdown from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of each value in back_out (dict)
+        _field_dict = {}
+        if self.back_out:
+            for _key in self.back_out:
+                if self.back_out[_key]:
+                    _field_dict[_key] = self.back_out[_key].to_dict()
+            _dict['backOut'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in dealing (dict)
+        _field_dict = {}
+        if self.dealing:
+            for _key in self.dealing:
+                if self.dealing[_key]:
+                    _field_dict[_key] = self.dealing[_key].to_dict()
+            _dict['dealing'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in pn_l (dict)
+        _field_dict = {}
+        if self.pn_l:
+            for _key in self.pn_l:
+                if self.pn_l[_key]:
+                    _field_dict[_key] = self.pn_l[_key].to_dict()
+            _dict['pnL'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of gav
+        if self.gav:
+            _dict['gav'] = self.gav.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in fees (dict)
+        _field_dict = {}
+        if self.fees:
+            for _key in self.fees:
+                if self.fees[_key]:
+                    _field_dict[_key] = self.fees[_key].to_dict()
+            _dict['fees'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of nav
+        if self.nav:
+            _dict['nav'] = self.nav.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of unitisation
+        if self.unitisation:
+            _dict['unitisation'] = self.unitisation.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in miscellaneous (dict)
+        _field_dict = {}
+        if self.miscellaneous:
+            for _key in self.miscellaneous:
+                if self.miscellaneous[_key]:
+                    _field_dict[_key] = self.miscellaneous[_key].to_dict()
+            _dict['miscellaneous'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of previous_share_class_breakdown
+        if self.previous_share_class_breakdown:
+            _dict['previousShareClassBreakdown'] = self.previous_share_class_breakdown.to_dict()
+        # set to None if miscellaneous (nullable) is None
+        # and __fields_set__ contains the field
+        if self.miscellaneous is None and "miscellaneous" in self.__fields_set__:
+            _dict['miscellaneous'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ShareClassBreakdown:
+        """Create an instance of ShareClassBreakdown from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ShareClassBreakdown.parse_obj(obj)
+
+        _obj = ShareClassBreakdown.parse_obj({
+            "back_out": dict(
+                (_k, ShareClassAmount.from_dict(_v))
+                for _k, _v in obj.get("backOut").items()
+            )
+            if obj.get("backOut") is not None
+            else None,
+            "dealing": dict(
+                (_k, ShareClassAmount.from_dict(_v))
+                for _k, _v in obj.get("dealing").items()
+            )
+            if obj.get("dealing") is not None
+            else None,
+            "pn_l": dict(
+                (_k, ShareClassAmount.from_dict(_v))
+                for _k, _v in obj.get("pnL").items()
+            )
+            if obj.get("pnL") is not None
+            else None,
+            "gav": MultiCurrencyAmounts.from_dict(obj.get("gav")) if obj.get("gav") is not None else None,
+            "fees": dict(
+                (_k, FeeAccrual.from_dict(_v))
+                for _k, _v in obj.get("fees").items()
+            )
+            if obj.get("fees") is not None
+            else None,
+            "nav": MultiCurrencyAmounts.from_dict(obj.get("nav")) if obj.get("nav") is not None else None,
+            "unitisation": UnitisationData.from_dict(obj.get("unitisation")) if obj.get("unitisation") is not None else None,
+            "miscellaneous": dict(
+                (_k, ShareClassAmount.from_dict(_v))
+                for _k, _v in obj.get("miscellaneous").items()
+            )
+            if obj.get("miscellaneous") is not None
+            else None,
+            "share_class_to_fund_fx_rate": obj.get("shareClassToFundFxRate"),
+            "capital_ratio": obj.get("capitalRatio"),
+            "previous_share_class_breakdown": PreviousShareClassBreakdown.from_dict(obj.get("previousShareClassBreakdown")) if obj.get("previousShareClassBreakdown") is not None else None
+        })
+        return _obj

lusid/models/share_class_data.py

@@ -0,0 +1,79 @@
+# 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 typing import Any, Dict, Optional
+from pydantic.v1 import BaseModel, Field
+from lusid.models.share_class_breakdown import ShareClassBreakdown
+from lusid.models.share_class_details import ShareClassDetails
+
+class ShareClassData(BaseModel):
+    """
+    The data for a Share Class. Includes Valuation Point Data and instrument information.  # noqa: E501
+    """
+    share_class_breakdown: ShareClassBreakdown = Field(..., alias="shareClassBreakdown")
+    share_class_details: Optional[ShareClassDetails] = Field(None, alias="shareClassDetails")
+    __properties = ["shareClassBreakdown", "shareClassDetails"]
+
+    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) -> ShareClassData:
+        """Create an instance of ShareClassData from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # override the default output from pydantic by calling `to_dict()` of share_class_breakdown
+        if self.share_class_breakdown:
+            _dict['shareClassBreakdown'] = self.share_class_breakdown.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of share_class_details
+        if self.share_class_details:
+            _dict['shareClassDetails'] = self.share_class_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ShareClassData:
+        """Create an instance of ShareClassData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ShareClassData.parse_obj(obj)
+
+        _obj = ShareClassData.parse_obj({
+            "share_class_breakdown": ShareClassBreakdown.from_dict(obj.get("shareClassBreakdown")) if obj.get("shareClassBreakdown") is not None else None,
+            "share_class_details": ShareClassDetails.from_dict(obj.get("shareClassDetails")) if obj.get("shareClassDetails") is not None else None
+        })
+        return _obj

lusid/models/share_class_details.py

@@ -0,0 +1,108 @@
+# 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 typing import Any, Dict, Optional
+from pydantic.v1 import BaseModel, Field, StrictStr, constr, validator
+
+class ShareClassDetails(BaseModel):
+    """
+    ShareClassDetails
+    """
+    lusid_instrument_id: Optional[constr(strict=True, max_length=64, min_length=1)] = Field(None, alias="lusidInstrumentId", description="LUSID's internal unique instrument identifier, resolved from the share class' instrument identifiers")
+    instrument_scope: Optional[constr(strict=True, max_length=64, min_length=1)] = Field(None, alias="instrumentScope", description="The scope in which the share class instrument lies.")
+    dom_currency: Optional[StrictStr] = Field(None, alias="domCurrency", description="The domestic currency of the share class instrument")
+    __properties = ["lusidInstrumentId", "instrumentScope", "domCurrency"]
+
+    @validator('lusid_instrument_id')
+    def lusid_instrument_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        return value
+
+    @validator('instrument_scope')
+    def instrument_scope_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[a-zA-Z0-9\-_]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9\-_]+$/")
+        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) -> ShareClassDetails:
+        """Create an instance of ShareClassDetails 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)
+        # set to None if lusid_instrument_id (nullable) is None
+        # and __fields_set__ contains the field
+        if self.lusid_instrument_id is None and "lusid_instrument_id" in self.__fields_set__:
+            _dict['lusidInstrumentId'] = None
+
+        # set to None if instrument_scope (nullable) is None
+        # and __fields_set__ contains the field
+        if self.instrument_scope is None and "instrument_scope" in self.__fields_set__:
+            _dict['instrumentScope'] = None
+
+        # set to None if dom_currency (nullable) is None
+        # and __fields_set__ contains the field
+        if self.dom_currency is None and "dom_currency" in self.__fields_set__:
+            _dict['domCurrency'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ShareClassDetails:
+        """Create an instance of ShareClassDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ShareClassDetails.parse_obj(obj)
+
+        _obj = ShareClassDetails.parse_obj({
+            "lusid_instrument_id": obj.get("lusidInstrumentId"),
+            "instrument_scope": obj.get("instrumentScope"),
+            "dom_currency": obj.get("domCurrency")
+        })
+        return _obj

lusid/models/staged_modification.py

@@ -44,8 +44,9 @@ class StagedModification(BaseModel):
     entity_unique_id: Optional[StrictStr] = Field(None, alias="entityUniqueId", description="The unique Id of the entity the staged modification applies to.")
     requested_changes: Optional[RequestedChanges] = Field(None, alias="requestedChanges")
     entity_hrefs: Optional[StagedModificationsEntityHrefs] = Field(None, alias="entityHrefs")
+    display_name: Optional[StrictStr] = Field(None, alias="displayName", description="The display name of the entity the staged modification applies to.")
     links: Optional[conlist(Link)] = None
-    __properties = ["id", "asAtStaged", "userIdStaged", "requestedIdStaged", "action", "stagingRule", "decisions", "decisionsCount", "status", "entityType", "scope", "entityUniqueId", "requestedChanges", "entityHrefs", "links"]
+    __properties = ["id", "asAtStaged", "userIdStaged", "requestedIdStaged", "action", "stagingRule", "decisions", "decisionsCount", "status", "entityType", "scope", "entityUniqueId", "requestedChanges", "entityHrefs", "displayName", "links"]
 
     class Config:
         """Pydantic configuration"""
@@ -139,6 +140,11 @@ class StagedModification(BaseModel):
         if self.entity_unique_id is None and "entity_unique_id" in self.__fields_set__:
             _dict['entityUniqueId'] = None
 
+        # set to None if display_name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.display_name is None and "display_name" in self.__fields_set__:
+            _dict['displayName'] = None
+
         # set to None if links (nullable) is None
         # and __fields_set__ contains the field
         if self.links is None and "links" in self.__fields_set__:
@@ -170,6 +176,7 @@ class StagedModification(BaseModel):
             "entity_unique_id": obj.get("entityUniqueId"),
             "requested_changes": RequestedChanges.from_dict(obj.get("requestedChanges")) if obj.get("requestedChanges") is not None else None,
             "entity_hrefs": StagedModificationsEntityHrefs.from_dict(obj.get("entityHrefs")) if obj.get("entityHrefs") is not None else None,
+            "display_name": obj.get("displayName"),
             "links": [Link.from_dict(_item) for _item in obj.get("links")] if obj.get("links") is not None else None
         })
         return _obj

lusid/models/transaction_configuration_movement_data.py

@@ -27,13 +27,13 @@ class TransactionConfigurationMovementData(BaseModel):
     """
     TransactionConfigurationMovementData
     """
-    movement_types: StrictStr = Field(..., alias="movementTypes", description=". The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee")
+    movement_types: StrictStr = Field(..., alias="movementTypes", description="Movement types determine the impact of the movement on the holdings. The available values are: Settlement, Traded, StockMovement, FutureCash,  Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee. The available values are: Settlement, Traded, StockMovement, FutureCash, Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee")
     side: constr(strict=True, min_length=1) = Field(..., description="The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration")
     direction: StrictInt = Field(..., description=" A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease")
     properties: Optional[Dict[str, PerpetualProperty]] = Field(None, description="The properties associated with the underlying Movement")
     mappings: Optional[conlist(TransactionPropertyMapping)] = Field(None, description="This allows you to map a transaction property to a property on the underlying holding")
     name: Optional[StrictStr] = Field(None, description="The movement name (optional)")
-    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment' and 'IncludesTradedInterest'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
+    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
     __properties = ["movementTypes", "side", "direction", "properties", "mappings", "name", "movementOptions"]
 
     @validator('movement_types')

lusid/models/transaction_configuration_movement_data_request.py

@@ -33,7 +33,7 @@ class TransactionConfigurationMovementDataRequest(BaseModel):
     properties: Optional[Dict[str, PerpetualProperty]] = Field(None, description="The properties associated with the underlying Movement.")
     mappings: Optional[conlist(TransactionPropertyMappingRequest)] = Field(None, description="This allows you to map a transaction property to a property on the underlying holding.")
     name: Optional[StrictStr] = Field(None, description="The movement name (optional)")
-    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment' and 'IncludesTradedInterest'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
+    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
     __properties = ["movementTypes", "side", "direction", "properties", "mappings", "name", "movementOptions"]
 
     @validator('movement_types')

lusid/models/transaction_field_map.py

@@ -34,7 +34,7 @@ class TransactionFieldMap(BaseModel):
     transaction_date: constr(strict=True, max_length=1024, min_length=0) = Field(..., alias="transactionDate")
     settlement_date: constr(strict=True, max_length=1024, min_length=0) = Field(..., alias="settlementDate")
     units: constr(strict=True, max_length=1024, min_length=0) = Field(...)
-    transaction_price: TransactionPriceAndType = Field(..., alias="transactionPrice")
+    transaction_price: Optional[TransactionPriceAndType] = Field(None, alias="transactionPrice")
     transaction_currency: constr(strict=True, max_length=1024, min_length=0) = Field(..., alias="transactionCurrency")
     exchange_rate: Optional[constr(strict=True, max_length=1024, min_length=0)] = Field(None, alias="exchangeRate")
     total_consideration: TransactionCurrencyAndAmount = Field(..., alias="totalConsideration")

lusid/models/transaction_type_movement.py

@@ -27,13 +27,13 @@ class TransactionTypeMovement(BaseModel):
     """
     TransactionTypeMovement
     """
-    movement_types: constr(strict=True, min_length=1) = Field(..., alias="movementTypes", description="Movement types determine the impact of the movement on the holdings")
+    movement_types: constr(strict=True, min_length=1) = Field(..., alias="movementTypes", description="Movement types determine the impact of the movement on the holdings. The available values are: Settlement, Traded, StockMovement, FutureCash,  Commitment, Receivable, CashSettlement, CashForward, CashCommitment, CashReceivable, Accrual, CashAccrual, ForwardFx, CashFxForward, UnsettledCashTypes, Carry, CarryAsPnl, VariationMargin, Capital, Fee.")
     side: constr(strict=True, max_length=64, min_length=1) = Field(..., description="The Side determines which of the fields from our transaction are used to generate the Movement. Side1 means the 'security' side of the transaction, ie the Instrument and Units; Side2 means the 'cash' side, ie the Total Consideration")
     direction: StrictInt = Field(..., description=" A multiplier to apply to Transaction amounts; the values are -1 to indicate to reverse the signs and 1 to indicate to use the signed values from the Transaction directly. For a typical Transaction with unsigned values, 1 means increase, -1 means decrease")
     properties: Optional[Dict[str, PerpetualProperty]] = Field(None, description="The properties associated with the underlying Movement")
     mappings: Optional[conlist(TransactionTypePropertyMapping, max_items=5000)] = Field(None, description="This allows you to map a transaction property to a property on the underlying holding")
     name: Optional[constr(strict=True, max_length=512, min_length=1)] = Field(None, description="The movement name (optional)")
-    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment' and 'IncludesTradedInterest'. A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
+    movement_options: Optional[conlist(StrictStr)] = Field(None, alias="movementOptions", description="Allows extra specifications for the movement. The options currently available are 'DirectAdjustment', 'IncludesTradedInterest' and 'Virtual' (works only with the movement type 'StockMovement'). A movement type of 'StockMovement' with an option of 'DirectAdjusment' will allow you to adjust the units of a holding without affecting its cost base. You will, therefore, be able to reflect the impact of a stock split by loading a Transaction.")
     settlement_date_override: Optional[StrictStr] = Field(None, alias="settlementDateOverride", description="Optional property key that must be in the Transaction domain when specified. When the movement is processed and the transaction has this property set to a valid date, then the property value will override the SettlementDate of the transaction.")
     condition: Optional[constr(strict=True, max_length=16384, min_length=0)] = Field(None, description="The condition that the transaction must satisfy to generate the movement, such as: Portfolio.BaseCurrency eq 'GBP'. The condition can contain fields and properties from transactions and portfolios. If no condition is provided, the movement will apply for all transactions of this type.")
     __properties = ["movementTypes", "side", "direction", "properties", "mappings", "name", "movementOptions", "settlementDateOverride", "condition"]